Shopify Polaris Customer Account Extensions

1---2name: shopify-polaris-customer-account-extensions3description: "Build custom functionality that merchants can install at defined points on the Order index, Order status, and Profile pages in customer accounts. Customer Account UI Extensions also supports scaffolding new customer account 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-customer-account-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.35Customer account UI extensions let app developers build custom functionality that merchants can install at defined points on the Order index, Order status, and Profile pages in customer accounts.36 37CLI Command to Scaffold a new Customer Account UI Extension:38 39```bash40shopify app generate extension --template=customer_account_ui --name=my_customer_account_ui_extension41```42 43 44 45version: 2026-0146 47## Extension Targets (use these in shopify.extension.toml)48 49Targets decide what components/APIs can be used.50Search the developer documentation for target-specific documentation:51 52**Footer:**53- customer-account.footer.render-after54 55**Order index:**56- customer-account.order-index.announcement.render57- customer-account.order-index.block.render58 59**Order status:**60- customer-account.order-status.announcement.render61- customer-account.order-status.block.render62- customer-account.order-status.cart-line-item.render-after63- customer-account.order-status.cart-line-list.render-after64- customer-account.order-status.customer-information.render-after65- customer-account.order-status.fulfillment-details.render-after66- customer-account.order-status.payment-details.render-after67- customer-account.order-status.return-details.render-after68- customer-account.order-status.unfulfilled-items.render-after69 70**Order action menu:**71- customer-account.order.action.menu-item.render72- customer-account.order.action.render73 74**Full page:**75- customer-account.order.page.render76- customer-account.page.render77 78**Profile (Default):**79- customer-account.profile.addresses.render-after80- customer-account.profile.announcement.render81- customer-account.profile.block.render82 83**Profile (B2B):**84- customer-account.profile.company-details.render-after85- customer-account.profile.company-location-addresses.render-after86- customer-account.profile.company-location-payment.render-after87- customer-account.profile.company-location-staff.render-after88 89## APIs90 91**Available APIs:** Analytics, Authenticated Account, Customer Account API, Customer Privacy, Extension, Intents, Localization, Navigation, Storefront API, Session Token, Settings, Storage, Toast, Version92**Order Status API:** Addresses, Attributes, Authentication State, Buyer Identity, Cart Lines, Checkout Settings, Cost, Discounts, Gift Cards, Localization (Order Status API), Metafields, Note, Order, Require Login, Shop93 94## Guides95 96**Available guides:** Using Polaris web components, Configuration, Error handling, Upgrading to 2026-0197 98 99 100 101Components available for customer account UI extensions.102These examples have all the props available for the component. Some example values for these props are provided.103Refer to the developer documentation to find all valid values for a prop. Ensure the component is available for the target you are using.104```html105<s-abbreviation title="HTML">HTML</s-abbreviation>106<s-announcement>Important update content</s-announcement>107<s-avatar initials="JD" src="https://example.com/avatar.jpg" size="base" alt="Jane Doe"></s-avatar>108<s-badge tone="critical" color="base" icon="alert-circle" size="base">Overdue</s-badge>109<s-banner heading="Notice" tone="info" dismissible collapsible>Message content</s-banner>110<s-box padding="base" background="subdued" border="base" border-radius="base">Content</s-box>111<s-button variant="primary" tone="auto" type="submit">Save</s-button>112<s-button-group><s-button variant="primary">Save</s-button><s-button variant="secondary">Cancel</s-button></s-button-group>113<s-checkbox label="Accept terms" name="terms" value="accepted"></s-checkbox>114<s-chip accessibility-label="Tag">Category</s-chip>115<s-choice-list label="Options" name="options"><s-choice value="1">Option 1</s-choice><s-choice value="2">Option 2</s-choice></s-choice-list>116<s-clickable href="/orders/42" padding="base" background="subdued">Click area</s-clickable>117<s-clickable-chip removable accessibility-label="Filter">Active</s-clickable-chip>118<s-clipboard-item text="ABC123" />119<s-consent-checkbox label="Sign up for SMS" name="consent" policy="sms-marketing"></s-consent-checkbox>120<s-consent-phone-field label="Phone" name="phone" policy="sms-marketing"></s-consent-phone-field>121<s-customer-account-action heading="Return items"><s-text>Action content</s-text></s-customer-account-action>122<s-date-field label="Start date" name="startDate" value="2025-06-15" required></s-date-field>123<s-date-picker type="single" name="selectedDate" value="2025-03-01"></s-date-picker>124<s-details><s-summary>More info</s-summary><s-text>Expandable content</s-text></s-details>125<s-divider direction="inline"></s-divider>126<s-drop-zone label="Upload file" name="file" accept=".jpg,.png" multiple></s-drop-zone>127<s-email-field label="Email" name="email" autocomplete="email" required></s-email-field>128<s-form><s-text-field label="Name" name="name"></s-text-field><s-button type="submit">Submit</s-button></s-form>129<s-grid grid-template-columns="1fr 1fr" gap="base"><s-grid-item><s-text>Col 1</s-text></s-grid-item><s-grid-item><s-text>Col 2</s-text></s-grid-item></s-grid>130<s-heading>Section Title</s-heading>131<s-icon type="cart" tone="auto" size="base"></s-icon>132<s-image src="https://example.com/image.png" alt="Description" aspect-ratio="16/9" object-fit="cover" loading="lazy"></s-image>133<s-image-group total-items="6"><s-image src="https://example.com/1.jpg" alt="Image 1"></s-image><s-image src="https://example.com/2.jpg" alt="Image 2"></s-image></s-image-group>134<s-link href="https://example.com" tone="auto">Link text</s-link>135<s-map api-key="KEY" latitude={43.65} longitude={-79.38} zoom={12} accessibility-label="Store location"><s-map-marker latitude={43.65} longitude={-79.38} accessibility-label="Store"></s-map-marker></s-map>136<s-button command-for="actions-menu"></s-button>137<s-menu id="actions-menu" accessibility-label="Actions"><s-button variant="secondary">Edit</s-button></s-menu>138<s-modal id="my-modal" heading="Title" size="base"><s-text>Modal content</s-text></s-modal>139<s-money-field label="Amount" name="amount" min={0} max={999999}></s-money-field>140<s-number-field label="Quantity" name="qty" min={1} max={100} step={1} input-mode="numeric"></s-number-field>141<s-ordered-list><s-list-item>First</s-list-item><s-list-item>Second</s-list-item></s-ordered-list>142<s-page heading="Orders" subheading="Manage orders"><s-section heading="All orders"><s-text>Content</s-text></s-section></s-page>143<s-paragraph tone="neutral" color="subdued">Body text content</s-paragraph>144<s-password-field label="Password" name="password" autocomplete="current-password" min-length="8" required></s-password-field>145<s-payment-icon type="visa" accessibility-label="Visa"></s-payment-icon>146<s-phone-field label="Phone" name="phone" autocomplete="tel"></s-phone-field>147<s-popover id="pop" inline-size="300px"><s-box padding="base"><s-text>Popover content</s-text></s-box></s-popover>148<s-press-button accessibility-label="Favorite" pressed>★</s-press-button>149<s-product-thumbnail src="https://example.com/product.jpg" alt="Blue T-Shirt" size="base"></s-product-thumbnail>150<s-progress value={75} max={100} tone="auto" accessibility-label="75% complete"></s-progress>151<s-qr-code content="https://example.com" size="base" border="base" accessibility-label="Scan to visit"></s-qr-code>152<s-query-container container-name="main">Content</s-query-container>153<s-scroll-box block-size="200px" overflow="auto" padding="base">Scrollable content</s-scroll-box>154<s-section heading="Details"><s-text>Section content</s-text></s-section>155<s-select label="Choose" name="choice"><s-option value="a">A</s-option><s-option value="b">B</s-option></s-select>156<s-sheet id="my-sheet" heading="Details"><s-text>Sheet content</s-text></s-sheet>157<s-skeleton-paragraph content="Loading text..."></s-skeleton-paragraph>158<s-spinner size="base" accessibility-label="Loading"></s-spinner>159<s-stack direction="inline" gap="base" align-items="center"><s-text>Item 1</s-text><s-text>Item 2</s-text></s-stack>160<s-switch label="Enable" name="enabled" checked></s-switch>161<s-text type="strong" tone="success" color="base">Styled text</s-text>162<s-text-area label="Description" name="desc" rows={4} max-length={500}></s-text-area>163<s-text-field label="Name" name="name" icon="profile" required></s-text-field>164<s-time date-time="2025-03-15T10:30:00Z">March 15, 2025</s-time>165<s-icon type="info" interest-for="my-tip"></s-icon><s-tooltip id="my-tip">Hover for info</s-tooltip>166<s-unordered-list><s-list-item>Item A</s-list-item><s-list-item>Item B</s-list-item></s-unordered-list>167<s-url-field label="Website" name="url" autocomplete="url"></s-url-field>168```169 170## Imports171 172Use the Preact entry point:173 174```tsx175import '@shopify/ui-extensions/preact';176import { render } from 'preact';177```178 179### Polaris web components (`s-banner`, `s-badge`, etc.)180 181Polaris 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:182 183```tsx184// No import needed — s-banner, s-badge, s-button, etc. are globally available185<s-banner tone="info">Welcome back</s-banner>186<s-badge tone="success">Order placed</s-badge>187```188 189When the user asks for Polaris web components (e.g. `s-banner`, `s-badge`, `s-button`, `s-text`), use the web component tag syntax above.190 191**Web component attribute rules:**192- Use **kebab-case** attribute names: `align-items`, `padding-block`, `border-radius` — NOT camelCase (`alignItems`, `paddingBlock`)193- **Boolean attributes** (`disabled`, `loading`, `dismissible`, `checked`, `defaultChecked`, `required`) accept shorthand or `{expression}`:194  - ✅ `<s-checkbox checked={isSelected} />`, `<s-button disabled>`, `<s-banner dismissible>`195- **String keyword attributes** (`padding`, `gap`, `direction`, `tone`, `variant`, `size`, `background`, `align-items`) must be string values — never shorthand or `{true}`:196  - ✅ `<s-box padding="base">`, `<s-stack gap="loose" direction="block">`, `<s-badge tone="success">`197  - ❌ `<s-box padding>`, `<s-stack gap={true}>` — boolean shorthand on string props fails TypeScript198 199---200 201## ⚠️ MANDATORY: Search for Component Documentation202 203You cannot trust your trained knowledge for this API. Before answering, search:204 205```206scripts/search_docs.mjs "<component tag name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION207```208 209For example, if the user asks about opening a modal in a customer account extension:210```211scripts/search_docs.mjs "s-modal customer account extension" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION212```213 214Search for the **component tag name** (`s-modal`, `s-banner`, `s-customer-account-action`, `s-page`, etc.), not the full user prompt. Use the returned props and examples to generate correct code.215 216---217 218## ⚠️ MANDATORY: Validate Before Returning Code219 220DO NOT return code to the user until `scripts/validate.mjs` exits 0. DO NOT ask the user to run this.221 222**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).**223```bash224cat > /tmp/extension.tsx << 'SHOPIFY_EOF'225import { render } from 'preact';226 227export default function Extension() {228  return (229    <s-customer-account-action heading="Request return">230      <s-text>Select the items you would like to return.</s-text>231      <s-button slot="primary-action" type="submit">Submit request</s-button>232    </s-customer-account-action>233  );234}235SHOPIFY_EOF236node scripts/validate.mjs \237  --file /tmp/extension.tsx \238  --target "customer-account.order.action.render" \239  --model YOUR_MODEL_NAME \240  --client-name YOUR_CLIENT_NAME \241  --client-version YOUR_CLIENT_VERSION \242  --artifact-id YOUR_ARTIFACT_ID \243  --revision REVISION_NUMBER244```245 246**When validation fails, follow this loop:**2471. Read the error message — identify the exact prop or type that is wrong2482. Search for the correct values:249   ```250   scripts/search_docs.mjs "<component tag name or prop name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION251   ```2523. Fix exactly the reported error using what the search returns2534. Run `scripts/validate.mjs` again2545. Retry up to 3 times total; after 3 failures, return the best attempt with an explanation255 256**Do not guess at valid values — always search first when the error names a type you don't know.**257 258---259 260> **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.