Improve API docs for buttons and improve overall doc consistency #2117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rajsite
approved these changes
May 17, 2024
Co-authored-by: Milan Raj <rajsite@users.noreply.github.com>
1 task
jattasNI
added a commit
that referenced
this pull request
May 24, 2024
# Pull Request ## 🤨 Rationale Ongoing efforts towards #824. This PR covers input components: - select - combobox - radio group - text area - text field - number field - checkbox - switch ## 👩💻 Implementation Generally follow patterns from previous PRs like #2126 and #2117. A few interesting notes: 1. components have different behaviors regarding whether they sync their `value` property to an attribute. I documented the behavior I observed by adding a new table category for properties that don't have attributes (also used by checkbox indeterminate property). 2. not yet documenting a recommendation to use form association / CVAs instead of change events and value properties. Until I do so, the `placeholder` docs for select are outside any table category. 3. added another new table category for localizable strings. 4. not yet documenting list option API in the select and combobox stories. We (probably Meyer) are going to tackle this in a follow up after #2111. ## 🧪 Testing <!--- Detail the testing done to ensure this submission meets requirements. Include automated/manual test additions or modifications, testing done on a local build, private CI run results, and additional testing not covered by automatic pull request validation. If any functionality is not covered by automated testing, provide justification. --> ## ✅ Checklist <!--- Review the list and put an x in the boxes that apply or ~~strike through~~ around items that don't (along with an explanation). --> - [x] I have updated the project documentation to reflect my changes or determined no changes are needed. --------- Co-authored-by: m-akinc <7282195+m-akinc@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
🤨 Rationale
As part of #824 we want to improve the accuracy and comprehensiveness of our storybook API documentation.
👩💻 Implementation
button,toggle-button, andcard-buttonto follow new API doc pattern. (I'll doanchor-buttonalong with other anchors).🧪 Testing
Local storybook exploration
✅ Checklist