[Components]: Description improvements for version 2026-04-rc#3821
Open
mcvinci wants to merge 6 commits into2026-04-rcfrom
Open
[Components]: Description improvements for version 2026-04-rc#3821mcvinci wants to merge 6 commits into2026-04-rcfrom
mcvinci wants to merge 6 commits into2026-04-rcfrom
Conversation
mcvinci
added
documentation
mcvinci
force-pushed
the
admin-ui-component-descriptions-2026-04-rc
branch
3 times, most recently
from
2c11c80 to
53d243b
Compare
mcvinci
force-pushed
the
admin-ui-component-descriptions-2026-04-rc
branch
2 times, most recently
from
d560865 to
0ec88a6
Compare
mcvinci
added
the
#gsd:49303
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 <cursoragent@cursor.com> 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 <cursoragent@cursor.com> 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 Component cross-references in intros Links + de-duplicating best practices / limitations Remove link Clarify defaultValue + placeholder props Update remaining defaultValue descriptions to plain English Update the 5 remaining instances of the old "uncontrolled components" description across shared.d.ts and components.d.ts to match the clearer defaultValue description style. Co-authored-by: Cursor <cursoragent@cursor.com> Use 'The placeholder' instead of 'Placeholder' in prop descriptions Co-authored-by: Cursor <cursoragent@cursor.com>
Integrate style feedback from Steve Remove file change
mcvinci
force-pushed
the
admin-ui-component-descriptions-2026-04-rc
branch
from
62b3f1d to
cf01dfe
Compare
SteveSill
approved these changes
Feb 14, 2026
Contributor
SteveSill
left a comment
SteveSill
left a comment
There was a problem hiding this comment.
Approved, pending changes from: #3787 (review)
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
2 participants
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.
This PR: