Skip to content

[Target APIs content]: Examples and descriptions for 2024-10#3826

Merged
SteveSill merged 1 commit into2024-10from
2024-10-admin-ui-examples
Feb 6, 2026
Merged

[Target APIs content]: Examples and descriptions for 2024-10#3826
SteveSill merged 1 commit into2024-10from
2024-10-admin-ui-examples

Conversation

@SteveSill
Copy link
Copy Markdown
Contributor

@SteveSill SteveSill commented Feb 5, 2026

Admin UI Extensions - Examples 2024-10

Summary

This PR adds comprehensive code examples for all Admin UI Extension Target APIs in the 2025-10 version. All examples follow the modern Preact pattern established in POS UI Extensions, using .jsx files with the global shopify object.

image image

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 5, 2026

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

@SteveSill SteveSill force-pushed the 2024-10-admin-ui-examples branch 3 times, most recently from e71b0d1 to d202b75 Compare February 5, 2026 22:38
Copy link
Copy Markdown
Contributor

@mcvinci mcvinci left a comment

Choose a reason for hiding this comment

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

There are a handful of example files that we can actually clean up from this PR, given that some of the APIs don't exist in this version. I've added some comments about that below.

🚀 🚀 Also, approving, pending these suggestions are considered for this version as well: #3823 (review)

@@ -0,0 +1,42 @@
import {extension, Button} from '@shopify/ui-extensions/admin';
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we need all these examples in this version, given the Picker API isn't available?

Banner,
} from '@shopify/ui-extensions-react/admin';

const ConfigureDiscountThreshold = () => {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same here. I don't think we need these examples in this version, given the Discount Function Settings API isn't available in this version.

@@ -0,0 +1,53 @@
import {extension, Text, Button, Banner} from '@shopify/ui-extensions/admin';
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same here. This API isn't available in this version, so we can remove the examples.

@@ -0,0 +1,13 @@
import {extension} from '@shopify/ui-extensions/admin';
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should Render API isn't available in this version, so we should remove the example files.

@SteveSill SteveSill force-pushed the 2024-10-admin-ui-examples branch 2 times, most recently from a084fff to 433b88f Compare February 6, 2026 05:55
@SteveSill SteveSill self-assigned this Feb 6, 2026
@SteveSill SteveSill force-pushed the 2024-10-admin-ui-examples branch 4 times, most recently from 667cebc to a250637 Compare February 6, 2026 20:47
Co-authored-by: Cursor <cursoragent@cursor.com>
@SteveSill SteveSill force-pushed the 2024-10-admin-ui-examples branch from a250637 to 1740a45 Compare February 6, 2026 21:11
@SteveSill SteveSill merged commit 3d8ae0f into 2024-10 Feb 6, 2026
7 checks passed
@mcvinci mcvinci added the #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness label Feb 10, 2026
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