-
Notifications
You must be signed in to change notification settings - Fork 86
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
Docs: Improve KTextbox component documentation with examples #604
Docs: Improve KTextbox component documentation with examples #604
Conversation
This change will be released as part of v4.
Cleanup changelog on the develop branch
Merge `release-v4` into `develop`
…to-develop-2 Merge release-v4 into develop: Part 2
Thank you, @GarvitSinghal47. Could you retarget to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @GarvitSinghal47 this is great. I left a couple comments and only one is blocking re: adding a note about the focus-ability of disabled inputs.
Also looks like the linter found something as well.
Thanks both @GarvitSinghal47 and @nucleogenesis, looking great and good suggestions. This is nothing blocking, just a suggestion for possible improvement. I think it's always helpful to show how code for examples look like. Demonstration of this can be seen in some newer documentation pages, e.g. that of for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The latest changes LGTM! Love seeing the code examples there :) thanks Garvit -- I'll leave it to @MisRob to decide when to merge from here.
Thanks both, it's looking great overall. Just one last thing before we merge. |
Co-authored-by: Michaela Robosova <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @GarvitSinghal47 and @nucleogenesis, this is a valuable improvement of the documentation
Fixes #596
Description
This pull request enhances the documentation of our component by adding initial examples for selected props. Not all variations are included, but we've added examples for 'invalid' and 'invalidText' with notes for user guidance, 'disabled', 'number' with 'min' and 'max' attributes, 'textarea', and 'label'. This improvement aims to make the component documentation more comprehensive and user-friendly. Further updates and discussions on additional examples can be made after these initial changes.
Changelog
Steps to test
Implementation notes
At a high level, how did you implement this?
These changes involve updating the documentation markdown files to include examples for the selected props.
Does this introduce any tech-debt items?
No, these changes do not introduce any tech debt items.
Testing checklist
Reviewer guidance
After review
CHANGELOG.md
Comments