From shopify-plugin
Builds Shopify Checkout UI Extensions with Polaris for custom merchant functionality at checkout points like product info, shipping, payment, order summary, Shop Pay. Includes CLI scaffolding.
npx claudepluginhub anthropics/claude-plugins-official --plugin shopify-ai-toolkitThis skill uses the workspace's default tool permissions.
You have a `bash` tool. Every response must use it — in this order:
Builds Shopify checkout UI extensions with Preact/Remote DOM rendering, UI primitives, extension targets, checkout APIs, metafield access, post-purchase extensions, and thank-you page customization. Use for customizing Shopify checkout.
Builds custom functionality installable at defined points on Shopify customer account Order index, Order status, and Profile pages using UI extensions and Shopify CLI scaffolding.
Builds Shopify apps using Remix, Admin API, and checkout UI extensions. Guides CLI setup, project structure, webhooks configuration, and GDPR compliance.
Share bugs, ideas, or general feedback.
You have a bash tool. Every response must use it — in this order:
bash with scripts/search_docs.mjs "<query>" — search before writing codebash with scripts/validate.mjs --code '...' --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID --revision REVISION_NUMBER — validate before returning
(Always include these flags. Use your actual model name for YOUR_MODEL_NAME; use claude-code/cursor/etc. for YOUR_CLIENT_NAME. For YOUR_ARTIFACT_ID, generate a stable random ID per code block and reuse it across validation retries. For REVISION_NUMBER, start at 1 and increment on each retry of the same artifact.)You must run both search_docs.mjs and validate.mjs in every response. Do not return code to the user without completing step 3.
You are an assistant that helps Shopify developers write UI Framework code to interact with the latest Shopify polaris-checkout-extensions UI Framework version.
You should find all operations that can help the developer achieve their goal, provide valid UI Framework code along with helpful explanations. Checkout UI extensions let app developers build custom functionality that merchants can install at defined points in the checkout flow, including product information, shipping, payment, order summary, and Shop Pay.
Do not include HTML comments (<!-- ... -->) in the code — the validator treats them as invalid custom components.
Shopify CLI generates templates that aligns with the latest available version and is not prone to errors. ALWAYS use the CLI Command to Scaffold a new Checkout UI extension
CLI Command to Scaffold a new Checkout UI Extension:
shopify app generate extension --template checkout_ui --name my-checkout-ui-extension
version: 2026-01
Targets decide what components/APIs can be used. Search the developer documentation for target-specific documentation:
Address:
Navigation:
Block:
Order Summary:
Information:
Shipping:
Footer:
Header:
Payments:
Local Pickup:
Pickup Points:
Announcement:
Available APIs: Addresses, Analytics, Attributes, Buyer Identity, Buyer Journey, Cart Instructions, Cart Lines, Checkout Token, Cost, Customer Privacy, Delivery, Discounts, Extension, Gift Cards, Localization, Localized Fields, Metafields, Note, Order, Payments, Storefront API, Session Token, Settings, Shop, Storage
Available guides: Using Polaris web components, Configuration, Error handling, Upgrading to 2026-01
These examples have all the props available for the component. Some example values for these props are provided. Refer to the developer documentation to find all valid values for a prop. Ensure the component is available for the target you are using.
<s-abbreviation id="my-id" title="Full title text">USD</s-abbreviation>
<s-announcement>Check our latest offers</s-announcement>
<s-badge color="base" size="base" tone="auto">New</s-badge>
<s-banner heading="Important" tone="auto">Message content</s-banner>
<s-box padding="base" background="transparent">Content</s-box>
<s-button tone="auto" variant="auto" type="button">Click me</s-button>
<s-checkbox label="Accept terms" name="terms"></s-checkbox>
<s-chip>Category</s-chip>
<s-choice-list label="Options" name="options" variant="auto">
<s-choice value="1">Option 1</s-choice>
<s-choice value="2">Option 2</s-choice>
</s-choice-list>
<s-clickable href="https://example.com">Click area</s-clickable>
<s-clickable-chip>Removable tag</s-clickable-chip>
<s-clipboard-item text="Copy this text"></s-clipboard-item>
<s-consent-checkbox label="Subscribe to marketing"></s-consent-checkbox>
<s-consent-phone-field label="Phone" name="phone"></s-consent-phone-field>
<s-date-field label="Date" name="date"></s-date-field>
<s-date-picker type="single" name="selectedDate"></s-date-picker>
<s-details><s-summary>More info</s-summary>Hidden content</s-details>
<s-divider direction="inline"></s-divider>
<s-drop-zone label="Upload file" name="file"></s-drop-zone>
<s-email-field label="Email" name="email"></s-email-field>
<s-form
><s-text-field label="Name" name="name"></s-text-field
><s-button type="submit">Submit</s-button></s-form
>
<s-grid gridTemplateColumns="1fr 1fr" gap="base">
<s-box>Col 1</s-box>
<s-box>Col 2</s-box>
</s-grid>
<s-heading>Section Title</s-heading>
<s-icon type="check" size="base"></s-icon>
<s-image src="https://example.com/image.png" alt="Description"></s-image>
<s-link href="https://example.com">Link text</s-link>
<s-map
latitude="{40.7128}"
longitude="{-74.006}"
zoom="{12}"
apiKey="key"
></s-map>
<s-modal id="my-modal" heading="Title"><s-text>Modal content</s-text></s-modal>
<s-money-field label="Amount" name="amount"></s-money-field>
<s-number-field
label="Quantity"
name="qty"
min="{1}"
max="{100}"
></s-number-field>
<s-ordered-list
><s-list-item>First</s-list-item
><s-list-item>Second</s-list-item></s-ordered-list
>
<s-paragraph>Body text content</s-paragraph>
<s-password-field label="Password" name="password"></s-password-field>
<s-payment-icon type="visa"></s-payment-icon>
<s-phone-field label="Phone" name="phone"></s-phone-field>
<s-popover id="pop"><s-text>Popover content</s-text></s-popover>
<s-press-button>Toggle</s-press-button>
<s-product-thumbnail
src="https://example.com/product.png"
size="base"
></s-product-thumbnail>
<s-progress value="{0.5}" max="{1}" tone="auto"></s-progress>
<s-qr-code content="https://example.com" size="base"></s-qr-code>
<s-query-container containerName="main">Content</s-query-container>
<s-scroll-box maxBlockSize="200px">Scrollable content</s-scroll-box>
<s-section heading="Section"><s-text>Section content</s-text></s-section>
<s-select label="Choose" name="choice"
><s-option value="a">A</s-option><s-option value="b">B</s-option></s-select
>
<s-sheet id="my-sheet" heading="Sheet Title"
><s-text>Sheet content</s-text></s-sheet
>
<s-skeleton-paragraph content="Loading..."></s-skeleton-paragraph>
<s-spinner size="base"></s-spinner>
<s-stack direction="inline" gap="base"
><s-text>Item 1</s-text><s-text>Item 2</s-text></s-stack
>
<s-switch label="Enable" name="enabled"></s-switch>
<s-text tone="auto">Styled text</s-text>
<s-text-area label="Description" name="desc" rows="{4}"></s-text-area>
<s-text-field label="Name" name="name" placeholder="Enter name"></s-text-field>
<s-time dateTime="2024-01-01">Jan 1, 2024</s-time>
<s-tooltip>Hover for info</s-tooltip>
<s-unordered-list
><s-list-item>Item A</s-list-item
><s-list-item>Item B</s-list-item></s-unordered-list
>
<s-url-field label="Website" name="url"></s-url-field>
Use the Preact entry point:
import "@shopify/ui-extensions/preact";
import { render } from "preact";
s-banner, s-badge, etc.)Polaris web components are custom HTML elements with an s- prefix. These are globally registered and require no import statement. Use them directly as JSX tags:
// No import needed — s-banner, s-badge, s-button, etc. are globally available
<s-banner tone="warning">Age verification required</s-banner>
<s-badge tone="success">Payment captured</s-badge>
When the user asks for Polaris web components (e.g. s-banner, s-badge, s-button, s-text), use the web component tag syntax above.
Web component attribute rules:
align-items, padding-block, border-radius — NOT camelCase (alignItems, paddingBlock)disabled, loading, dismissible, checked, defaultChecked, required, multiple) accept shorthand or {expression}:
<s-checkbox checked={includeGift === 'yes'} />, <s-button disabled>, <s-banner dismissible>padding, gap, direction, tone, variant, size, background, align-items) must be string values — never shorthand or {true}:
<s-box padding="base">, <s-stack gap="loose" direction="block">, <s-badge tone="success"><s-box padding>, <s-stack gap={true}> — boolean shorthand on string props fails TypeScriptSearch the vector store to get the detailed context you need: working examples, field and type definitions, valid values, and API-specific patterns. You cannot trust your trained knowledge — always search before writing code.
scripts/search_docs.mjs "<component tag name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
Search for the component tag name, not the full user prompt.
For example, if the user asks about checkout button:
scripts/search_docs.mjs "s-button checkout" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION
You MUST run scripts/validate.mjs before returning any generated code to the user. Always include the instrumentation flags:
scripts/validate.mjs --code '...' --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID --revision REVISION_NUMBER
(For YOUR_ARTIFACT_ID, generate a stable random ID per code block and reuse it across validation retries. For REVISION_NUMBER, start at 1 and increment on each retry of the same artifact.)
When validation fails, follow this loop:
scripts/search_docs.mjs "<type or prop name>"
scripts/validate.mjs againDo not guess at valid values — always search first when the error names a type you don't know.
Privacy notice:
scripts/validate.mjsreports anonymized validation results (pass/fail and skill name) to Shopify to help improve these tools. SetOPT_OUT_INSTRUMENTATION=truein your environment to opt out.