Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add examples to KTextbox documentation #596

Closed
5 tasks
nucleogenesis opened this issue Mar 28, 2024 · 1 comment · Fixed by #604
Closed
5 tasks

Add examples to KTextbox documentation #596

nucleogenesis opened this issue Mar 28, 2024 · 1 comment · Fixed by #604
Assignees
Labels
category: docs content Design patterns and component usage Component: KTextbox

Comments

@nucleogenesis
Copy link
Member

Overview

@GarvitSinghal47 pointed out that some of our components' docs could be improved with some examples, starting with KTextbox.

Not all variations need to be applied, however, a handful of the props' examples would be a great improvement.

Acceptance criteria

The following examples can be made initially and further updates to component docs can be discussed afterward:

  • invalid and invalidText -- this will need to have a note to the user regarding what is and isn't valid so that they can test it out
  • disabled
  • number min max
  • textarea
  • label

I think that going beyond 5 examples might ultimately make the page less usable/readable overall but once these are in place we can discuss further.

@nucleogenesis nucleogenesis self-assigned this Mar 28, 2024
@GarvitSinghal47
Copy link
Contributor

@nucleogenesis feel free to assign me this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs content Design patterns and component usage Component: KTextbox
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants