shopify-polaris-admin-extensions

What this skill does

<!-- AUTO-GENERATED — do not edit directly.
     Edit src/data/raw-api-instructions/{api}.md in shopify-dev-tools,
     then run: npm run generate_agent_skills (outputs to distributed-agent-skills/) -->
---
name: shopify-polaris-admin-extensions
description: "Add custom actions and blocks from your app at contextually relevant spots throughout the Shopify Admin. Admin UI Extensions also supports scaffolding new adminextensions using Shopify CLI commands."
compatibility: Claude Code, Claude Desktop, Cursor
metadata:
  author: Shopify
---

You are an assistant that helps Shopify developers write UI Framework code to interact with the latest Shopify polaris-admin-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.
Admin Extensions integrate into the Shopify admin at contextual locations for merchant workflows.
Admin actions are a UI extension that you can use to create transactional workflows within existing pages of the Shopify admin. Merchants can launch these UI extensions from the More actions menus on resource pages or from an index table's bulk action menu when one or more resources are selected. After the UI extensions are launched, they display as modals. After they're closed, the page updates with the changes from the action.

## IMPORTANT : ALWAYS USE THE CLI TO SCAFFOLD A NEW EXTENSION

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 Admin UI extension

CLI Command to Scaffold a new Admin Action Extension

```bash
shopify app generate extension --template admin_action --name my-admin-action
```

 Admin blocks are built with UI extensions and enable your app to embed contextual information and inputs directly on resource pages in the Shopify admin. When a merchant has added them to their pages, these UI extensions display as cards inline with the other resource information. Merchants need to manually add and pin the block to their page in the Shopify admin before they can use it.
 With admin blocks, merchants can view and modify information from your app and other data on the page simultaneously. To facilitate complex interactions and transactional changes, you can launch admin actions directly from admin blocks.

 CLI Command to Scaffold a new Admin Block Extension:

 ```bash
 shopify app generate extension --template admin_block --name my-admin-block
 ```

 Admin link extensions let you direct merchants from pages in the Shopify admin to related, complex workflows in your app. For example, the Shopify Flow app has an admin link extension that directs merchants to a page of the app where they can run an automation for any order:
```bash
shopify app generate extension --template admin_link --name admin-link-extension
```

Admin print actions are a special form of UI extension designed to let your app print documents from key pages in the Shopify admin. Unlike typical actions provided by UI extensions, admin print actions are found under the Print menu on orders and product pages. Additionally, they contain special APIs to let your app display a preview of a document and print it.
CLI Command to Scaffold a new Admin Print Action Extension:

```bash
shopify app generate extension --template admin_print --name my-admin-print-extension
```


version: 2026-01

## Target APIs

**Contextual APIs:** Customer Segment Template Extension API, Discount Function Settings API, Order Routing Rule API, Product Details Configuration API, Product Variant Details Configuration API, Purchase Options Card Configuration API, Validation Settings API
**Core APIs:** Action Extension API, Block Extension API, Print Action Extension API, Standard API
**Utility APIs:** Intents API, Picker API, Resource Picker API, Should Render API

## Polaris Web Components

**Actions:** Button, ButtonGroup, Clickable, ClickableChip, Link, Menu
**Feedback and status indicators:** Badge, Banner, Spinner
**Forms:** Checkbox, ChoiceList, ColorField, ColorPicker, DateField, DatePicker, EmailField, Form, FunctionSettings, MoneyField, NumberField, PasswordField, SearchField, Select, Switch, TextArea, TextField, URLField
**Layout and structure:** Box, Divider, Grid, OrderedList, QueryContainer, Section, Stack, Table, UnorderedList
**Media and visuals:** Avatar, Icon, Image, Thumbnail
**Settings and templates:** AdminAction, AdminBlock, AdminPrintAction
**Typography and content:** Chip, Heading, Paragraph, Text, Tooltip

## Guides

**Available guides:** Network Features



## Components available for Admin UI extensions.
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.
```html
<s-admin-action heading="Edit product" loading>Content</s-admin-action>
<s-admin-block heading="Custom Fields" collapsed-summary="3 fields configured">Content</s-admin-block>
<s-admin-print-action src="https://example.com/invoice.pdf"></s-admin-print-action>
<s-avatar initials="JD" src="https://example.com/avatar.jpg" size="base" alt="Jane Doe"></s-avatar>
<s-badge tone="success" color="base" icon="check-circle" size="base">Fulfilled</s-badge>
<s-banner heading="Important notice" tone="info" dismissible hidden>Message content</s-banner>
<s-box accessibility-label="Container" accessibility-role="group" accessibility-visibility="visible" background="subdued" block-size="auto" border="base" border-color="base" border-radius="base" border-style="solid" border-width="base" display="auto" inline-size="100%" max-block-size="500px" max-inline-size="100%" min-block-size="100px" min-inline-size="50px" overflow="hidden" padding="base" padding-block="large" padding-block-start="base" padding-block-end="base" padding-inline="large" padding-inline-start="base" padding-inline-end="base">Content</s-box>
<s-button accessibility-label="Save product" disabled command="--show" command-for="my-modal" icon="save" interest-for="my-tooltip" lang="en" loading type="submit" tone="auto" variant="primary" target="_blank" href="https://example.com" download="file.csv" inline-size="fill">Save</s-button>
<s-button-group gap="base" accessibility-label="Actions"><s-button slot="primary-action" variant="primary">Save</s-button><s-button slot="secondary-actions">Cancel</s-button></s-button-group>
<s-checkbox accessibility-label="Accept" checked default-checked details="Required" error="Must accept" label="Accept terms" required name="terms" disabled value="accepted" indeterminate default-indeterminate></s-checkbox>
<s-chip color="base" accessibility-label="Category">Electronics</s-chip>
<s-choice-list details="Pick shipping" disabled error="Required" label="Shipping method" label-accessibility-visibility="exclusive" multiple name="shipping" values={["standard"]}><s-choice value="standard" selected default-selected disabled accessibility-label="Standard shipping">Standard</s-choice><s-choice value="express">Express</s-choice></s-choice-list>
<s-clickable accessibility-label="View product" command="--show" command-for="detail-modal" disabled download="file.pdf" href="/products/42" interest-for="tip" lang="en" loading target="_blank" type="button" padding="base" background="subdued" border-radius="base">Content</s-clickable>
<s-clickable-chip color="base" accessibility-label="Filter" removable hidden href="/filter" disabled command="--show" command-for="chip-menu" interest-for="chip-tip">Active</s-clickable-chip>
<s-color-field name="brandColor" value="#FF5733" default-value="#000000" disabled label="Brand color" label-accessibility-visibility="exclusive" placeholder="Pick color" read-only required error="Invalid" details="Brand color" autocomplete="off" alpha></s-color-field>
<s-color-picker alpha value="#3498DB" default-value="#0000