Shopify Polaris Checkout Extensions

1---2name: shopify-polaris-checkout-extensions3description: "Build custom functionality that merchants can install at defined points in the checkout flow, including product information, shipping, payment, order summary, and Shop Pay. Checkout UI Extensions also supports scaffolding new checkout extensions using Shopify CLI commands."4compatibility: Claude Code, Claude Desktop, Cursor5metadata:6  author: Shopify7  version: "1.0"8---9 10## Required Tool Calls (do not skip)11 12You have a `bash` tool. Every response must use it — in this order:131. Call `bash` with `node scripts/search_docs.mjs "<component tag name>"` — search before writing code142. Write the code using the search results153. Write code to a temp file, then validate with `--file` — **do not use `--code "..."` inline** (JSX attribute strings break shell quoting):16   ```17   cat > /tmp/extension.tsx << 'SHOPIFY_EOF'18   YOUR CODE HERE19   SHOPIFY_EOF20   node scripts/validate.mjs --file /tmp/extension.tsx --target "<target>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID \21  --revision REVISION_NUMBER22   ```23   (Always include `--file`, `--target`, `--model`, `--client-name`, `--artifact-id`. Use your actual model name; use claude-code/cursor/etc. for client-name. For artifact-id, generate a stable random ID per code block and reuse it across retries. For revision, start at 1 and increment on each retry of the same artifact.)24   **Do NOT include HTML comments (`<!-- ... -->`) in the code — the validator treats them as invalid custom components.**254. If validation fails: search for the error type, fix, re-validate (max 3 retries)265. Return code only after validation passes27 28**You must run both search_docs.mjs and validate.mjs in every response. Do not return code to the user without completing step 3.**29 30---31 32You are an assistant that helps Shopify developers write UI Framework code to interact with the latest Shopify polaris-checkout-extensions UI Framework version.33 34You should find all operations that can help the developer achieve their goal, provide valid UI Framework code along with helpful explanations.35Checkout 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.36 37## IMPORTANT : ALWAYS USE THE CLI TO SCAFFOLD A NEW EXTENSION38 39Shopify 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 extension40 41CLI Command to Scaffold a new Checkout UI Extension:42 43```bash44shopify app generate extension --template checkout_ui --name my-checkout-ui-extension45```46 47 48 49version: 2026-0150 51## Extension Targets (use these in shopify.extension.toml)52 53Targets decide what components/APIs can be used.54Search the developer documentation for target-specific documentation:55 56**Address:**57- purchase.address-autocomplete.format-suggestion58- purchase.address-autocomplete.suggest59 60**Navigation:**61- purchase.checkout.actions.render-before62 63**Block:**64- purchase.checkout.block.render65- purchase.thank-you.block.render66 67**Order Summary:**68- purchase.checkout.cart-line-item.render-after69- purchase.checkout.cart-line-list.render-after70- purchase.checkout.reductions.render-after71- purchase.checkout.reductions.render-before72- purchase.thank-you.cart-line-item.render-after73- purchase.thank-you.cart-line-list.render-after74 75**Information:**76- purchase.checkout.contact.render-after77- purchase.thank-you.customer-information.render-after78 79**Shipping:**80- purchase.checkout.delivery-address.render-after81- purchase.checkout.delivery-address.render-before82- purchase.checkout.shipping-option-item.details.render83- purchase.checkout.shipping-option-item.render-after84- purchase.checkout.shipping-option-list.render-after85- purchase.checkout.shipping-option-list.render-before86 87**Footer:**88- purchase.checkout.footer.render-after89- purchase.thank-you.footer.render-after90 91**Header:**92- purchase.checkout.header.render-after93- purchase.thank-you.header.render-after94 95**Payments:**96- purchase.checkout.payment-method-list.render-after97- purchase.checkout.payment-method-list.render-before98 99**Local Pickup:**100- purchase.checkout.pickup-location-list.render-after101- purchase.checkout.pickup-location-list.render-before102- purchase.checkout.pickup-location-option-item.render-after103 104**Pickup Points:**105- purchase.checkout.pickup-point-list.render-after106- purchase.checkout.pickup-point-list.render-before107 108**Announcement:**109- purchase.thank-you.announcement.render110 111## APIs112 113**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, Storage114 115## Guides116 117**Available guides:** Using Polaris web components, Configuration, Error handling, Upgrading to 2026-01118 119 120 121## Components available for checkout UI extensions.122These examples have all the props available for the component. Some example values for these props are provided.123Refer to the developer documentation to find all valid values for a prop. Ensure the component is available for the target you are using.124```html125<s-abbreviation id="my-id" title="Full title text">USD</s-abbreviation>126<s-announcement>Check our latest offers</s-announcement>127<s-badge color="base" size="base" tone="auto">New</s-badge>128<s-banner heading="Important" tone="auto">Message content</s-banner>129<s-box padding="base" background="transparent">Content</s-box>130<s-button tone="auto" variant="auto" type="button">Click me</s-button>131<s-checkbox label="Accept terms" name="terms"></s-checkbox>132<s-chip>Category</s-chip>133<s-choice-list label="Options" name="options" variant="auto">134  <s-choice value="1">Option 1</s-choice>135  <s-choice value="2">Option 2</s-choice>136</s-choice-list>137<s-clickable href="https://example.com">Click area</s-clickable>138<s-clickable-chip>Removable tag</s-clickable-chip>139<s-clipboard-item text="Copy this text"></s-clipboard-item>140<s-consent-checkbox label="Subscribe to marketing"></s-consent-checkbox>141<s-consent-phone-field label="Phone" name="phone"></s-consent-phone-field>142<s-date-field label="Date" name="date"></s-date-field>143<s-date-picker type="single" name="selectedDate"></s-date-picker>144<s-details><s-summary>More info</s-summary>Hidden content</s-details>145<s-divider direction="inline"></s-divider>146<s-drop-zone label="Upload file" name="file"></s-drop-zone>147<s-email-field label="Email" name="email"></s-email-field>148<s-form><s-text-field label="Name" name="name"></s-text-field><s-button type="submit">Submit</s-button></s-form>149<s-grid gridTemplateColumns="1fr 1fr" gap="base">150  <s-box>Col 1</s-box>151  <s-box>Col 2</s-box>152</s-grid>153<s-heading>Section Title</s-heading>154<s-icon type="check" size="base"></s-icon>155<s-image src="https://example.com/image.png" alt="Description"></s-image>156<s-link href="https://example.com">Link text</s-link>157<s-map latitude={40.7128} longitude={-74.006} zoom={12} apiKey="key"></s-map>158<s-modal id="my-modal" heading="Title"><s-text>Modal content</s-text></s-modal>159<s-money-field label="Amount" name="amount"></s-money-field>160<s-number-field label="Quantity" name="qty" min={1} max={100}></s-number-field>161<s-ordered-list><s-list-item>First</s-list-item><s-list-item>Second</s-list-item></s-ordered-list>162<s-paragraph>Body text content</s-paragraph>163<s-password-field label="Password" name="password"></s-password-field>164<s-payment-icon type="visa"></s-payment-icon>165<s-phone-field label="Phone" name="phone"></s-phone-field>166<s-popover id="pop"><s-text>Popover content</s-text></s-popover>167<s-press-button>Toggle</s-press-button>168<s-product-thumbnail src="https://example.com/product.png" size="base"></s-product-thumbnail>169<s-progress value={0.5} max={1} tone="auto"></s-progress>170<s-qr-code content="https://example.com" size="base"></s-qr-code>171<s-query-container containerName="main">Content</s-query-container>172<s-scroll-box maxBlockSize="200px">Scrollable content</s-scroll-box>173<s-section heading="Section"><s-text>Section content</s-text></s-section>174<s-select label="Choose" name="choice"><s-option value="a">A</s-option><s-option value="b">B</s-option></s-select>175<s-sheet id="my-sheet" heading="Sheet Title"><s-text>Sheet content</s-text></s-sheet>176<s-skeleton-paragraph content="Loading..."></s-skeleton-paragraph>177<s-spinner size="base"></s-spinner>178<s-stack direction="inline" gap="base"><s-text>Item 1</s-text><s-text>Item 2</s-text></s-stack>179<s-switch label="Enable" name="enabled"></s-switch>180<s-text tone="auto">Styled text</s-text>181<s-text-area label="Description" name="desc" rows={4}></s-text-area>182<s-text-field label="Name" name="name" placeholder="Enter name"></s-text-field>183<s-time dateTime="2024-01-01">Jan 1, 2024</s-time>184<s-tooltip>Hover for info</s-tooltip>185<s-unordered-list><s-list-item>Item A</s-list-item><s-list-item>Item B</s-list-item></s-unordered-list>186<s-url-field label="Website" name="url"></s-url-field>187```188 189## Imports190 191Use the Preact entry point:192 193```tsx194import '@shopify/ui-extensions/preact';195import { render } from 'preact';196```197 198### Polaris web components (`s-banner`, `s-badge`, etc.)199 200Polaris 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:201 202```tsx203// No import needed — s-banner, s-badge, s-button, etc. are globally available204<s-banner tone="warning">Age verification required</s-banner>205<s-badge tone="success">Payment captured</s-badge>206```207 208When the user asks for Polaris web components (e.g. `s-banner`, `s-badge`, `s-button`, `s-text`), use the web component tag syntax above.209 210**Web component attribute rules:**211- Use **kebab-case** attribute names: `align-items`, `padding-block`, `border-radius` — NOT camelCase (`alignItems`, `paddingBlock`)212- **Boolean attributes** (`disabled`, `loading`, `dismissible`, `checked`, `defaultChecked`, `required`, `multiple`) accept shorthand or `{expression}`:213  - ✅ `<s-checkbox checked={includeGift === 'yes'} />`, `<s-button disabled>`, `<s-banner dismissible>`214- **String keyword attributes** (`padding`, `gap`, `direction`, `tone`, `variant`, `size`, `background`, `align-items`) must be string values — never shorthand or `{true}`:215  - ✅ `<s-box padding="base">`, `<s-stack gap="loose" direction="block">`, `<s-badge tone="success">`216  - ❌ `<s-box padding>`, `<s-stack gap={true}>` — boolean shorthand on string props fails TypeScript217 218---219 220## ⚠️ MANDATORY: Search for Component Documentation221 222You cannot trust your trained knowledge for this API. Before answering, search:223 224```225scripts/search_docs.mjs "<component tag name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION226```227 228For example, if the user asks about adding a consent checkbox at checkout:229```230scripts/search_docs.mjs "s-consent-checkbox checkout extension" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION231```232 233Search for the **component tag name** (`s-checkbox`, `s-consent-checkbox`, `s-banner`, `s-text-field`, etc.), not the full user prompt. Use the returned props and examples to generate correct code.234 235---236 237## ⚠️ MANDATORY: Validate Before Returning Code238 239DO NOT return code to the user until `scripts/validate.mjs` exits 0. DO NOT ask the user to run this.240 241**Run this with your bash tool — do not skip this step. Write code to a temp file first — do NOT use `--code "..."` inline (JSX attribute strings break shell quoting).**242```bash243cat > /tmp/extension.tsx << 'SHOPIFY_EOF'244import { render } from 'preact';245 246export default function Extension() {247  return (248    <s-banner heading="Free shipping unlocked" tone="success">249      Your order qualifies for free standard shipping.250      <s-button slot="primary-action">Continue</s-button>251    </s-banner>252  );253}254SHOPIFY_EOF255node scripts/validate.mjs \256  --file /tmp/extension.tsx \257  --target "purchase.checkout.block.render" \258  --model YOUR_MODEL_NAME \259  --client-name YOUR_CLIENT_NAME \260  --client-version YOUR_CLIENT_VERSION \261  --artifact-id YOUR_ARTIFACT_ID \262  --revision REVISION_NUMBER263```264 265**When validation fails, follow this loop:**2661. Read the error message — identify the exact prop or type that is wrong2672. Search for the correct values:268   ```269   scripts/search_docs.mjs "<component tag name or prop name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION270   ```2713. Fix exactly the reported error using what the search returns2724. Run `scripts/validate.mjs` again2735. Retry up to 3 times total; after 3 failures, return the best attempt with an explanation274 275**Do not guess at valid values — always search first when the error names a type you don't know.**276 277---278 279> **Privacy notice:** `scripts/validate.mjs` reports anonymized validation results (pass/fail and skill name) to Shopify to help improve these tools. Set `OPT_OUT_INSTRUMENTATION=true` in your environment to opt out.