Skip to content

[Components content]: Examples for 2025-07#3873

Open
SteveSill wants to merge 1 commit into2025-07from
2025-07-component-examples
Open

[Components content]: Examples for 2025-07#3873
SteveSill wants to merge 1 commit into2025-07from
2025-07-component-examples

Conversation

@SteveSill
Copy link
Contributor

@SteveSill SteveSill commented Feb 7, 2026

Summary

Rewrites all code examples and descriptions for the 36 admin UI extension components in the 2025-07 API version. The existing examples were minimal placeholders (single-prop demos, missing descriptions, no real use cases). This PR replaces them with examples that show devs how to use each component in realistic extension scearios.

What changed

Example code (216 files): Each component now has 3 examples, each with a .ts (imperative) and .tsx (React) version. Examples use real extension targets like admin.product-details.action.render and block.render, and demonstrate actual patterns developers need — querying the GraphQL Admin API, posting to backend endpoints, handling form submission, validating input, and working with data.selected, close(), and navigation.

Documentation (36 .doc.ts files + 65 React .doc.ts files): Every defaultExample and examples section has been updated with:

  • Action-oriented titles (5 words or fewer)
  • Two-sentence descriptions following the Shopify dev docs style guide: first sentence explains the business use case, second sentence covers the technical implementation
  • Links to related components and APIs where they help the reader (1-2 per description)

Prop validation: All props used in examples have been validated against the actual 2025-07 TypeScript type definitions to ensure no example references a prop, value, or component that doesn't exist in this version.

CSAT feedback

This PR closes the following feedback issues:

@SteveSill SteveSill self-assigned this Feb 7, 2026
@mcvinci mcvinci added the #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness label Feb 10, 2026
@SteveSill SteveSill force-pushed the 2025-07-component-examples branch 2 times, most recently from 32f0240 to 68095a0 Compare February 19, 2026 05:11
@SteveSill SteveSill requested a review from mcvinci February 19, 2026 05:16
@SteveSill SteveSill force-pushed the 2025-07-component-examples branch from bdfadb2 to a65fc8e Compare February 19, 2026 05:25
@SteveSill SteveSill marked this pull request as ready for review February 19, 2026 05:38
@SteveSill SteveSill force-pushed the 2025-07-component-examples branch from a65fc8e to 62670ee Compare February 19, 2026 05:39
@SteveSill SteveSill changed the title Draft of 2025-07 component examples [Components content]: Examples for 2025-07 Feb 19, 2026
@SteveSill SteveSill force-pushed the 2025-07-component-examples branch 2 times, most recently from aca7f7d to a488c2b Compare February 19, 2026 05:49
Co-authored-by: Cursor <cursoragent@cursor.com>
@SteveSill SteveSill force-pushed the 2025-07-component-examples branch from a488c2b to 30a561f Compare February 19, 2026 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Admin UI Extensions #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments