Skip to content

[Admin UI extensions 2026-04-rc] Cherry pick component example revisions#3985

Merged
mcvinci merged 6 commits into2026-04-rcfrom
cherry-pick-component-examples-2026-04-rc
Feb 25, 2026
Merged

[Admin UI extensions 2026-04-rc] Cherry pick component example revisions#3985
mcvinci merged 6 commits into2026-04-rcfrom
cherry-pick-component-examples-2026-04-rc

Conversation

@mcvinci
Copy link
Contributor

@mcvinci mcvinci commented Feb 25, 2026

…witch, URLField

Apply consistent 3-sentence pattern to all example descriptions:
- Purpose statement explaining why to use this pattern
- "This example shows..." describing specific implementation
- "Click to interact with the preview." CTA

Also corrected descriptions to accurately match example code.

Fix prettier formatting errors (curly quotes)

Co-authored-by: Cursor <cursoragent@cursor.com>

Remove references to non-existent JSX example files

Co-authored-by: Cursor <cursoragent@cursor.com>

Remove JSX tabs, collapse to HTML-only examples

Co-authored-by: Cursor <cursoragent@cursor.com>

Remove 'Click to interact with the preview' from descriptions

Co-authored-by: Cursor <cursoragent@cursor.com>

Fix misplaced modifier in URLField description

Co-authored-by: Cursor <cursoragent@cursor.com>

Address PR feedback for component documentation

Doc file updates (MoneyField, PasswordField, Select, Switch, URLField):
- Replace "This example shows" with specific verbs (pairs, configures, displays, groups, etc.)
- Fix awkward phrasing in descriptions
- Clarify readOnly vs disabled behavior in URLField examples
- Update password requirements checklist description

HTML example fixes:
- Use boolean attributes without ="true" (checked, disabled, required)
- Fix country/region capitalization (United States, North America, etc.)
- Remove contradictory value from MoneyField error example
- Add submit button to Switch form-integration example
- Remove unnecessary s-stack wrapper from URLField example
- Change placeholder to example.com in URLField

Co-authored-by: Cursor <cursoragent@cursor.com>
@mcvinci mcvinci force-pushed the cherry-pick-component-examples-2026-04-rc branch from e2f5453 to 31d8f26 Compare February 25, 2026 17:32
Updates example documentation for Avatar, Checkbox, ColorField, ColorPicker, and Icon components:

- Update all example descriptions to 3-sentence pattern
- Remove 6 redundant examples to reduce noise
- Fix ColorPicker default to show basic picker (no alpha)
- Merge format hint into ColorField default placeholder

Components: Avatar (8), Checkbox (5), ColorField (8), ColorPicker (2), Icon (8)

Collapse examples to HTML-only for batch2 components

- Remove JSX tabs, keep HTML with language: 'preview' for interactive previews
- Remove 'Click to interact with the preview.' from all descriptions
- Add missing backticks for property names and values
- Delete unused .jsx example files (keep JSX-only validation examples)

Address PR feedback for batch2 component docs

- Fix ColorField default example: remove dead placeholder code, add label
- Simplify ColorPicker and ColorField default descriptions to avoid
  restating component purpose
- All example descriptions use active verbs consistently
- All bolding has colons outside (**word**:)
- Add HTML examples for Checkbox and ColorField validation states

Co-authored-by: Cursor <cursoragent@cursor.com>

Add empty changeset for docs-only changes

Co-authored-by: Cursor <cursoragent@cursor.com>

Fix "This example shows" phrases in ColorPicker.doc.ts

Co-authored-by: Cursor <cursoragent@cursor.com>

Fix prettier errors with apostrophes in strings

Co-authored-by: Cursor <cursoragent@cursor.com>

Fix prettier whitespace formatting

Co-authored-by: Cursor <cursoragent@cursor.com>

Restore missing JSX example files from base branch

These JSX files are required for the docs build and were accidentally
omitted from the branch. Restoring from origin/2026-01.

Co-authored-by: Cursor <cursoragent@cursor.com>

Remove JSX references from ColorField.doc.ts and delete JSX files

- Update ColorField.doc.ts to use HTML-only examples with language: 'preview'
- Delete all JSX example files that were accidentally restored
- This completes the JSX to HTML conversion for batch 2 components

Co-authored-by: Cursor <cursoragent@cursor.com>
@mcvinci mcvinci force-pushed the cherry-pick-component-examples-2026-04-rc branch 2 times, most recently from 3d7b8b2 to f37efb3 Compare February 25, 2026 17:38
Updates example documentation for Image and Thumbnail components:

Image (8 examples):
- Swapped default to show simplest usage (src + alt)
- Added "Combine aspect ratio and sizing" for advanced usage
- Updated all descriptions to 3-sentence pattern
- Action-oriented titles throughout

Thumbnail (4 examples, was 5):
- Added description to default example
- Removed redundant "Basic usage" (identical to default)
- Updated all descriptions to 3-sentence pattern
- Action-oriented titles throughout

Update packages/ui-extensions/src/surfaces/admin/components/Image/Image.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/Image/Image.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/Thumbnail/Thumbnail.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Simplify examples for Image and Thumbnail components

- Collapse code examples to HTML only, removing duplicate JSX tabs
- Remove "Click to interact with the preview." from all descriptions
- Add backticks to property names in descriptions (srcSet, sizes, alt, etc.)
- Delete unused .jsx example files

Remove 'html' tab title from code blocks

Update code block language to 'preview' for Image and Thumbnail

Fix Events link to use correct polaris URL format

Improve Image and Thumbnail examples based on PR feedback

- Update basic Image example to show realistic product thumbnail with metadata
- Remove redundant auto-sized image example
- Clarify descriptions for objectFit and responsive images
- Fix Thumbnail alt texts to follow "Image of" convention
- Fix event handling example to use proper addEventListener pattern
  instead of React-style onLoad attribute
- Add both load and error handlers to match description

Address PR feedback for Image and Thumbnail docs

- Replace "This example shows" with active verbs
- Add periods to all bullet points
- Lowercase component names in prose (image, thumbnail)
- Fix Grid link to use proper URL format with API placeholders

Co-authored-by: Cursor <cursoragent@cursor.com>

Add empty changeset for docs-only changes

Co-authored-by: Cursor <cursoragent@cursor.com>
@mcvinci mcvinci force-pushed the cherry-pick-component-examples-2026-04-rc branch from f37efb3 to 91c93c1 Compare February 25, 2026 17:38
Selective cherry-pick of only DropZone-related changes from
uiext-polaris-modal-page-popover-dropzone branch (PR #3920).

Updates shared DropZone description, improves DropZone.doc.ts examples
and descriptions, removes JSX example files, and adds
upload-with-validation.html example.

Co-authored-by: Cursor <cursoragent@cursor.com>

Remove changeset files not needed for cherry-pick branch

Co-authored-by: Cursor <cursoragent@cursor.com>
@mcvinci mcvinci force-pushed the cherry-pick-component-examples-2026-04-rc branch from ac7c395 to 2734d3f Compare February 25, 2026 17:44
@mcvinci mcvinci self-assigned this Feb 25, 2026
@mcvinci mcvinci changed the title [Admin UI extensions] Cherry pick component example revisions [Admin UI extensions 2026-04-rc] Cherry pick component example revisions Feb 25, 2026
@mcvinci mcvinci added #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness Admin UI Extensions documentation Improvements or additions to documentation labels Feb 25, 2026
…ld, NumberField, SearchField, TextArea, and TextField

Update ChoiceList component code examples

Update DateField component code examples

Update EmailField component examples

Update NumberField component examples

Update SearchField component examples

Update TextArea component examples

Update TextField component examples

Flatten examples into a single array removing default and groups (e.g. Basic Usage)

Add title and descriptions for Button examples and restore basic usage example

Update descriptions and titles for ChoiceList examples

Update descriptions and titles for DateField examples

Update titles and descriptions for DatePicker examples

Update descriptions and titles for EmailField examples

Update descriptions and titles for NumberField examples

Update descriptions and titles for SearchField

Update descriptions and titles for TextArea examples

Update descriptions and titles for TExtField examples

Fix linting errors

Update packages/ui-extensions/src/surfaces/admin/components/Button/Button.doc.ts

Co-authored-by: Chad Carlson <chadwcarlson@users.noreply.github.com>

Update packages/ui-extensions/src/surfaces/admin/components/Button/Button.doc.ts

Co-authored-by: Chad Carlson <chadwcarlson@users.noreply.github.com>

Update packages/ui-extensions/src/surfaces/admin/components/ChoiceList/ChoiceList.doc.ts

Co-authored-by: Chad Carlson <chadwcarlson@users.noreply.github.com>

Update packages/ui-extensions/src/surfaces/admin/components/DatePicker/DatePicker.doc.ts

Co-authored-by: Chad Carlson <chadwcarlson@users.noreply.github.com>

Update packages/ui-extensions/src/surfaces/admin/components/Button/Button.doc.ts

Co-authored-by: Steve Silliker <steve.silliker@shopify.com>

Incorporate review feedback from @SteveSill

Remove jsx code examples

Correct syntax for code examples to make preview and codeblock render properly
Delete redundant examples from ButtonGroup page

Delete redundant examples from Clickable

Delete redundant examples from ClickableChip

Delete redundant code examples for Link component

Delete redundant code examples and add new example for Menu component

Update titles and descriptions for code examples

Update packages/ui-extensions/src/surfaces/admin/components/Clickable/Clickable.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/Clickable/Clickable.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/Clickable/Clickable.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/Clickable/Clickable.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/ClickableChip/ClickableChip.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/ClickableChip/ClickableChip.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/Link/Link.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Update packages/ui-extensions/src/surfaces/admin/components/Link/Link.doc.ts

Co-authored-by: Michelle Vinci <michelle.vinci@shopify.com>

Delete all jsx code examples for Polaris components leaving only HTML

Delete image properties from default examples

Revert changes to Chip component

Revert changes to Chip.doc.ts

Fix syntax for code examples so preview and code render properly

Incorporate review feedback from @SteveSill
@mcvinci mcvinci force-pushed the cherry-pick-component-examples-2026-04-rc branch from bce9b1c to ff5870d Compare February 25, 2026 18:03
@mcvinci mcvinci marked this pull request as ready for review February 25, 2026 18:05
Copy link
Contributor

@timtrevor-shopify timtrevor-shopify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good for my changes.

@mcvinci mcvinci merged commit d820a73 into 2026-04-rc Feb 25, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Admin UI Extensions documentation Improvements or additions to documentation #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants