[Components]: Description improvements for version 2026-01#3820
Open
[Components]: Description improvements for version 2026-01#3820
Conversation
Linting Improve prop descriptions + revert example desc changes Further description improvements Further description improvements Further description improvements More description improvements Further description improvements Description tweaks Intro description tweaks Revisions to limitations and best practices Update descriptions for App Home / Admin UI Polaris components Cherry-picked from 3c68898 with merge conflict resolution. Updated component descriptions for ChoiceList, DateField, DatePicker, EmailField, NumberField, SearchField, TextArea, and TextField to be more concise and focused on App Home / Admin UI use cases, removing POS-specific references. Co-authored-by: Cursor <[email protected]> Update best practices and limitations for App Home / Admin UI Polaris components Cherry-picked from c11d32e with merge conflict resolution. Updated best practices and limitations sections for ChoiceList, DateField, DatePicker, EmailField, NumberField, SearchField, TextArea, and TextField components. Combined concise, focused guidance with detailed practical examples to provide comprehensive documentation that balances clarity with actionable advice. Co-authored-by: Cursor <[email protected]> Refinements to descriptions ColorField + ColorPicker descriptions DateField + DatePicker descriptions Forms description improvements Descriptions for layout and structure components Media and visuals descriptions Descriptions for Typography and content Revert changes to Modal Revert changes to props for Modal, Popover, DropZone, and Page Revert accidental changes to Image and TextArea
mcvinci
force-pushed
the
admin-ui-component-descriptions-2026-01
branch
from
a763bab to
79ab77b
Compare
mcvinci
added
documentation
Contributor
|
We detected some changes in |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
You can preview individual component pages on staging 8:
Reviewers
I'm mostly looking for feedback on the following:
Feel free to compare the pages currently in production with the new ones too!
This PR: