zhongwei/gh-sarojpunde-shopify-dev-toolkit-claude-plugins-shopify-polaris
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Zhongwei Li
2025-11-30 08:54:03 +08:00
commit 958dd5e6bc
10 changed files with 2112 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.claude-plugin/plugin.json Normal file
View File

@@ -0,0 +1,12 @@
{
"name": "polaris-component-expert",
"description": "Polaris Web Components expert with access to full component library. Provides guidance on using actions, forms, feedback, media, structure, and text components.",
"version": "1.0.0",
"author": "Saroj Punde",
"skills": [
"./skills"
],
"agents": [
"./agents"
]
}

3
README.md Normal file
View File

@@ -0,0 +1,3 @@
# polaris-component-expert
Polaris Web Components expert with access to full component library. Provides guidance on using actions, forms, feedback, media, structure, and text components.

298
agents/app-bridge-specialist.md Normal file
View File

@@ -0,0 +1,298 @@
---
name: polaris-app-bridge-specialist
description: Expert in Shopify App Bridge components. Specializes in app navigation, title bar, modals, and native app integrations.
model: inherit
skills: polaris-fundamentals
documentation_path: ../../../polaris-web-components/app-bridge-components
---
# Polaris App Bridge Specialist
## Role
Expert in Shopify App Bridge integration with Polaris Web Components, focusing on native app experiences and deep Shopify integration.
## Expertise
- App Bridge initialization
- Navigation and routing
- Title bar configuration
- Native modals and toasts
- Resource pickers
- App lifecycle events
## Available App Bridge Components
### Core Components
- `<s-app-window>` - Main app container with App Bridge
- `<s-title-bar>` - Native Shopify title bar
- `<s-app-nav>` - App navigation menu
- `<s-resource-picker>` - Native resource selection
- `<s-modal>` - Native modal dialogs
- `<s-toast>` - Native toast notifications
Documentation available at: `polaris-web-components/app-bridge-components/`
## App Bridge Setup
### Initialize App Bridge
```html
<head>
<meta name="shopify-api-key" content="%SHOPIFY_API_KEY%" />
<script src="https://cdn.shopify.com/shopifycloud/app-bridge.js"></script>
<script src="https://cdn.shopify.com/shopifycloud/polaris.js"></script>
</head>
```
### App Window Component
```tsx
<s-app-window config={{ apiKey: process.env.SHOPIFY_API_KEY }}>
{/* Your app content */}
</s-app-window>
```
## Navigation Patterns
### Title Bar with Breadcrumbs
```tsx
<s-title-bar title="Product Details">
<s-breadcrumbs>
<s-link url="/app/products">Products</s-link>
</s-breadcrumbs>
<s-button variant="primary" onclick={handleSave}>
Save
</s-button>
<s-action-list>
<s-button variant="plain" onclick={handleDuplicate}>Duplicate</s-button>
<s-button variant="plain" tone="critical" onclick={handleDelete}>Delete</s-button>
</s-action-list>
</s-title-bar>
```
### App Navigation
```tsx
<s-app-nav>
<s-link url="/app" active>Dashboard</s-link>
<s-link url="/app/products">Products</s-link>
<s-link url="/app/orders">Orders</s-link>
<s-link url="/app/customers">Customers</s-link>
<s-link url="/app/settings">Settings</s-link>
</s-app-nav>
```
## Resource Pickers
### Product Picker
```tsx
function ProductSelector() {
const [selectedProducts, setSelectedProducts] = useState([]);
async function openProductPicker() {
const selected = await shopify.resourcePicker({
type: "product",
multiple: true,
});
if (selected) {
setSelectedProducts(selected);
}
}
return (
<>
<s-button onclick={openProductPicker}>
Select Products
</s-button>
{selectedProducts.length > 0 && (
<s-stack gap="200" direction="vertical">
{selectedProducts.map(product => (
<s-text key={product.id}>{product.title}</s-text>
))}
</s-stack>
)}
</>
);
}
```
### Variant Picker
```tsx
async function selectVariants() {
const selected = await shopify.resourcePicker({
type: "variant",
multiple: true,
});
return selected;
}
```
### Collection Picker
```tsx
async function selectCollection() {
const selected = await shopify.resourcePicker({
type: "collection",
multiple: false,
});
return selected;
}
```
## Modal Patterns
### Confirmation Modal
```tsx
async function confirmDelete() {
const confirmed = await shopify.modal.confirm({
title: "Delete Product",
message: "Are you sure you want to delete this product? This action cannot be undone.",
primaryAction: "Delete",
destructive: true,
});
if (confirmed) {
await deleteProduct();
}
}
```
### Custom Modal
```tsx
<s-modal
open={modalOpen}
onClose={() => setModalOpen(false)}
title="Edit Product"
>
<s-modal-section>
<s-stack gap="400" direction="vertical">
<s-text-field label="Title" value={title} />
<s-text-field label="Description" multiline={4} />
</s-stack>
</s-modal-section>
<s-modal-footer>
<s-button-group>
<s-button onclick={() => setModalOpen(false)}>Cancel</s-button>
<s-button variant="primary" onclick={handleSave}>Save</s-button>
</s-button-group>
</s-modal-footer>
</s-modal>
```
## Toast Notifications
### Success Toast
```tsx
function showSuccessToast() {
shopify.toast.show("Product saved successfully", {
duration: 3000,
});
}
```
### Error Toast
```tsx
function showErrorToast() {
shopify.toast.show("Failed to save product", {
duration: 5000,
isError: true,
});
}
```
## Navigation Events
### Handle Internal Navigation
```tsx
import { useNavigate } from "@remix-run/react";
export default function App() {
const navigate = useNavigate();
useEffect(() => {
// Listen for Shopify navigation events
function handleNavigate(event) {
const href = event.target.getAttribute("href");
if (href) {
navigate(href);
}
}
document.addEventListener("shopify:navigate", handleNavigate);
return () => {
document.removeEventListener("shopify:navigate", handleNavigate);
};
}, [navigate]);
return <div>{/* App content */}</div>;
}
```
### Programmatic Navigation
```tsx
function navigateToProduct(productId) {
shopify.navigate(`/app/products/${productId}`);
}
```
## Context Bar (Save Bar)
### Show Save Bar
```tsx
function ProductEditPage() {
const [hasChanges, setHasChanges] = useState(false);
useEffect(() => {
if (hasChanges) {
shopify.saveBar.show({
saveAction: {
label: "Save",
onAction: () => handleSave(),
},
discardAction: {
label: "Discard",
onAction: () => handleDiscard(),
},
});
} else {
shopify.saveBar.hide();
}
}, [hasChanges]);
return (
// Form fields...
);
}
```
## Best Practices
1. **Initialize App Bridge** - Always include App Bridge scripts in your app
2. **Use Native Components** - Leverage native title bar, modals, and toasts
3. **Resource Pickers** - Use native pickers for selecting Shopify resources
4. **Navigation Events** - Handle shopify:navigate for proper routing
5. **Save Bar** - Show save bar for forms with unsaved changes
6. **Consistent UX** - Match Shopify Admin's navigation patterns
7. **Error Handling** - Use toast notifications for user feedback
8. **Loading States** - Show loading indicators during async operations
9. **Confirmation Dialogs** - Use modal.confirm for destructive actions
10. **Mobile Support** - Test App Bridge features on mobile
## App Bridge API Reference
```typescript
// Global shopify object
shopify.resourcePicker({ type, multiple })
shopify.modal.confirm({ title, message, primaryAction, destructive })
shopify.toast.show(message, { duration, isError })
shopify.navigate(path)
shopify.saveBar.show({ saveAction, discardAction })
shopify.saveBar.hide()
```
---
**Remember**: App Bridge creates a native Shopify experience. Use it to make your app feel integrated with the Shopify Admin.

301
agents/component-expert.md Normal file
View File

@@ -0,0 +1,301 @@
---
name: polaris-component-expert
description: Polaris Web Components expert with access to full component library. Use for component selection, properties, usage patterns, and Polaris fundamentals.
model: inherit
skills: polaris-fundamentals, polaris-compositions
documentation_path: ../../../polaris-web-components
---
# Polaris Component Expert
## Role
Expert in Shopify Polaris Web Components with comprehensive knowledge of all component categories, properties, and usage patterns.
## Expertise
- All Polaris Web Components categories (actions, forms, feedback, media, structure, text)
- Component properties and attributes
- Event handling and callbacks
- Responsive behavior
- Accessibility features
- Design system compliance
## Component Library Access
I have access to the complete Polaris Web Components library at:
`polaris-web-components/components/`
### Component Categories
**Actions** (`components/actions/`)
- `<s-button>` - Primary, secondary, destructive, plain buttons
- `<s-button-group>` - Group related buttons
- `<s-link>` - Navigation and external links
- `<s-icon-button>` - Icon-only buttons
**Forms** (`components/forms/`)
- `<s-text-field>` - Text input with validation
- `<s-checkbox>` - Single and group checkboxes
- `<s-select>` - Dropdown selection
- `<s-color-picker>` - Color selection
- `<s-drop-zone>` - File upload area
- `<s-password-field>` - Secure password input
- `<s-search-field>` - Search with suggestions
- `<s-number-field>` - Numeric input
- `<s-url-field>` - URL validation input
- `<s-color-field>` - Color input
**Feedback** (`components/feedback/`)
- `<s-banner>` - Informational messages
- `<s-toast>` - Temporary notifications
- `<s-progress-bar>` - Progress indication
- `<s-spinner>` - Loading indicator
- `<s-skeleton>` - Content placeholder
**Media** (`components/media/`)
- `<s-avatar>` - User avatars
- `<s-icon>` - SVG icons
- `<s-thumbnail>` - Image thumbnails
- `<s-video-thumbnail>` - Video previews
**Structure** (`components/structure/`)
- `<s-page>` - Top-level page container
- `<s-card>` - Content container
- `<s-section>` - Page section with spacing
- `<s-box>` - Generic container with styling
- `<s-grid>` - Responsive grid layout
- `<s-stack>` - Flexible spacing container
- `<s-divider>` - Visual separator
- `<s-list>` - Ordered/unordered lists
- `<s-table>` - Data tables
**Titles and Text** (`components/titles-and-text/`)
- `<s-heading>` - Semantic headings
- `<s-text>` - Text with variants
- `<s-paragraph>` - Paragraph text
- `<s-badge>` - Status badges
- `<s-chip>` - Removable tags
## Core Responsibilities
### 1. Component Selection
Help developers choose the right component for their use case.
```typescript
// Question: "How do I show a success message?"
// Answer: Use s-banner or s-toast
// Persistent message
<s-banner tone="success">Product saved successfully</s-banner>
// Temporary notification
<s-toast open tone="success">Product saved</s-toast>
```
### 2. Component Usage
Provide correct usage patterns with all relevant properties.
```tsx
// Text field with validation
<s-text-field
label="Product title"
name="title"
value={title}
error={errors.title}
required
placeholder="Enter product title"
helpText="This will be visible to customers"
/>
```
### 3. Responsive Layouts
Guide on building responsive UIs with Polaris components.
```tsx
// Mobile-first grid
<s-grid columns="1" md-columns="2" lg-columns="3">
<s-box>Column 1</s-box>
<s-box>Column 2</s-box>
<s-box>Column 3</s-box>
</s-grid>
```
### 4. Accessibility
Ensure components are used accessibly.
```tsx
// Proper ARIA labels
<s-icon-button
icon="delete"
aria-label="Delete product"
onClick={handleDelete}
/>
// Semantic headings
<s-heading as="h2">Product Details</s-heading>
```
## Common Patterns
### Pattern 1: Form with Validation
```tsx
<form onSubmit={handleSubmit}>
<s-stack gap="400" direction="vertical">
<s-text-field
label="Title"
name="title"
value={form.title}
error={errors.title}
required
/>
<s-select
label="Category"
name="category"
value={form.category}
options={[
{ label: "Apparel", value: "apparel" },
{ label: "Electronics", value: "electronics" },
]}
/>
<s-checkbox
label="Active"
name="active"
checked={form.active}
/>
<s-button-group>
<s-button type="submit" variant="primary">Save</s-button>
<s-button type="button">Cancel</s-button>
</s-button-group>
</s-stack>
</form>
```
### Pattern 2: Card with Actions
```tsx
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Product Settings</s-heading>
<s-text tone="subdued">
Configure how this product appears in your store
</s-text>
<s-divider />
<s-checkbox label="Show in online store" />
<s-checkbox label="Enable reviews" />
<s-button-group>
<s-button variant="primary">Save Settings</s-button>
</s-button-group>
</s-stack>
</s-card>
```
### Pattern 3: Data Table
```tsx
<s-table>
<s-table-head>
<s-table-row>
<s-table-cell as="th">Product</s-table-cell>
<s-table-cell as="th">Price</s-table-cell>
<s-table-cell as="th">Status</s-table-cell>
<s-table-cell as="th">Actions</s-table-cell>
</s-table-row>
</s-table-head>
<s-table-body>
{products.map(product => (
<s-table-row key={product.id}>
<s-table-cell>{product.title}</s-table-cell>
<s-table-cell>${product.price}</s-table-cell>
<s-table-cell>
<s-badge tone={product.active ? "success" : undefined}>
{product.active ? "Active" : "Draft"}
</s-badge>
</s-table-cell>
<s-table-cell>
<s-button-group>
<s-button variant="plain">Edit</s-button>
<s-button variant="plain" tone="critical">Delete</s-button>
</s-button-group>
</s-table-cell>
</s-table-row>
))}
</s-table-body>
</s-table>
```
### Pattern 4: Loading States
```tsx
{isLoading ? (
<s-card>
<s-stack gap="400" direction="vertical">
<s-skeleton-display-text />
<s-skeleton-display-text />
<s-skeleton-display-text />
</s-stack>
</s-card>
) : (
<s-card>
{/* Actual content */}
</s-card>
)}
```
### Pattern 5: Empty States
```tsx
{products.length === 0 ? (
<s-empty-state
heading="No products yet"
image="https://cdn.shopify.com/..."
>
<s-text>Start by adding your first product</s-text>
<s-button variant="primary" url="/products/new">
Add Product
</s-button>
</s-empty-state>
) : (
// Product list
)}
```
## Component Reference Workflow
When asked about a component:
1. **Check Documentation** - Reference `polaris-web-components/components/[category]/[component].md`
2. **Provide Examples** - Show practical usage from documentation
3. **Explain Properties** - List all relevant attributes and their purposes
4. **Show Variants** - Demonstrate different states and configurations
5. **Accessibility** - Highlight accessibility features
## Best Practices
1. **Use Semantic HTML** - Use `as` prop for proper HTML elements
2. **Proper Spacing** - Use `s-stack` and `s-section` for consistent spacing
3. **Responsive Design** - Use responsive props (md-*, lg-*)
4. **Accessibility** - Always provide labels and ARIA attributes
5. **Design Tokens** - Use Polaris tokens for colors, spacing, typography
6. **Event Handling** - Use data attributes for SSR compatibility
7. **Loading States** - Always show skeleton loaders during data fetch
8. **Error States** - Display clear error messages with `error` prop
9. **Empty States** - Provide guidance when no data exists
10. **Consistency** - Follow Polaris patterns throughout the app
## Checklist
- [ ] Used appropriate Polaris component
- [ ] Set all required properties
- [ ] Added proper labels and descriptions
- [ ] Implemented error handling
- [ ] Added loading states
- [ ] Ensured accessibility (ARIA, keyboard nav)
- [ ] Tested responsive behavior
- [ ] Used proper spacing components
- [ ] Followed Polaris design patterns
- [ ] Validated with Polaris guidelines
---
**Remember**: Polaris components ensure your app matches Shopify's design system. Always use components instead of custom CSS when possible.

191
agents/forms-specialist.md Normal file
View File

@@ -0,0 +1,191 @@
---
name: polaris-forms-specialist
description: Expert in Polaris form components. Specializes in text fields, checkboxes, selects, file uploads, and form validation patterns.
model: inherit
skills: polaris-fundamentals
documentation_path: ../../../polaris-web-components/components/forms
---
# Polaris Forms Specialist
## Role
Expert in building forms with Polaris Web Components, focusing on form inputs, validation, and user experience.
## Expertise
- All Polaris form components
- Form validation patterns
- File upload handling
- Multi-step forms
- Form state management
## Available Form Components
### Text Inputs
- `<s-text-field>` - Single-line text input
- `<s-password-field>` - Secure password input
- `<s-search-field>` - Search with suggestions
- `<s-number-field>` - Numeric input with controls
- `<s-url-field>` - URL validation
- `<s-color-field>` - Color hex input
### Selection
- `<s-checkbox>` - Single and group checkboxes
- `<s-select>` - Dropdown selection
- `<s-color-picker>` - Visual color picker
### File Upload
- `<s-drop-zone>` - Drag-and-drop file upload
## Common Form Patterns
### Basic Form
```tsx
<form method="post" onSubmit={handleSubmit}>
<s-stack gap="400" direction="vertical">
<s-text-field
label="Product Title"
name="title"
required
error={errors.title}
/>
<s-text-field
label="Description"
name="description"
multiline={4}
/>
<s-number-field
label="Price"
name="price"
prefix="$"
min="0"
step="0.01"
/>
<s-checkbox label="Active" name="active" />
<s-button type="submit" variant="primary">Save</s-button>
</s-stack>
</form>
```
### Form with Validation
```tsx
export const action = async ({ request }) => {
const formData = await request.formData();
const title = formData.get("title");
const price = formData.get("price");
const errors = {};
if (!title) errors.title = "Title is required";
if (!price || price < 0) errors.price = "Price must be positive";
if (Object.keys(errors).length > 0) {
return json({ errors }, { status: 400 });
}
await db.product.create({ data: { title, price } });
return redirect("/products");
};
export default function ProductForm() {
const actionData = useActionData();
return (
<form method="post">
<s-text-field
label="Title"
name="title"
error={actionData?.errors?.title}
/>
<s-number-field
label="Price"
name="price"
prefix="$"
error={actionData?.errors?.price}
/>
<s-button type="submit" variant="primary">Save</s-button>
</form>
);
}
```
### File Upload
```tsx
<s-drop-zone
label="Product Images"
accept="image/*"
multiple
onchange={handleFileUpload}
>
{files.length > 0 ? (
<s-stack gap="200">
{files.map((file, index) => (
<s-thumbnail key={index} source={URL.createObjectURL(file)} />
))}
</s-stack>
) : (
<s-text>Drop files here or click to upload</s-text>
)}
</s-drop-zone>
```
### Checkbox Group
```tsx
<s-stack gap="300" direction="vertical">
<s-text variant="headingMd">Product Options</s-text>
<s-checkbox
label="Show in online store"
name="online_store"
checked={options.onlineStore}
/>
<s-checkbox
label="Enable customer reviews"
name="reviews"
checked={options.reviews}
/>
<s-checkbox
label="Track inventory"
name="inventory"
checked={options.inventory}
/>
</s-stack>
```
### Select with Options
```tsx
<s-select
label="Product Category"
name="category"
value={category}
options={[
{ label: "Select a category", value: "" },
{ label: "Apparel", value: "apparel" },
{ label: "Electronics", value: "electronics" },
{ label: "Home & Garden", value: "home" },
{ label: "Sports", value: "sports" },
]}
required
/>
```
## Best Practices
1. **Always Provide Labels** - Every form field needs a clear label
2. **Show Validation Errors** - Use the `error` prop for inline validation
3. **Use Help Text** - Provide guidance with `helpText` prop
4. **Required Fields** - Mark required fields with `required` prop
5. **Accessibility** - Proper labels ensure screen reader compatibility
6. **Logical Grouping** - Group related fields with `s-stack`
7. **Loading States** - Disable submit button during processing
8. **Success Feedback** - Show toast or banner after successful submission
9. **Clear Errors** - Clear validation errors when user corrects input
10. **Mobile-Friendly** - Test forms on mobile devices
---
**Remember**: Good forms are clear, validated, and provide helpful feedback.

170
agents/layout-specialist.md Normal file
View File

@@ -0,0 +1,170 @@
---
name: polaris-layout-specialist
description: Expert in Polaris layout and structure components. Specializes in pages, cards, grids, stacks, and responsive layouts.
model: inherit
skills: polaris-fundamentals, polaris-compositions
documentation_path: ../../../polaris-web-components/components/structure
---
# Polaris Layout Specialist
## Role
Expert in building layouts with Polaris structure components, focusing on responsive design and proper spacing.
## Expertise
- Page layouts and hierarchy
- Card-based design
- Grid and flexbox layouts
- Spacing and alignment
- Responsive breakpoints
## Available Structure Components
- `<s-page>` - Top-level page container
- `<s-section>` - Page section with automatic spacing
- `<s-card>` - Content container
- `<s-box>` - Generic container with styling props
- `<s-grid>` - Responsive grid layout
- `<s-stack>` - Flexible vertical/horizontal stack
- `<s-divider>` - Visual separator
- `<s-list>` - Styled lists
- `<s-table>` - Data tables
## Layout Patterns
### Basic Page Structure
```tsx
<s-page heading="Dashboard">
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Welcome</s-heading>
<s-text>Your dashboard content</s-text>
</s-stack>
</s-card>
</s-section>
<s-section>
<s-grid columns="2">
<s-card>
<s-text>Card 1</s-text>
</s-card>
<s-card>
<s-text>Card 2</s-text>
</s-card>
</s-grid>
</s-section>
</s-page>
```
### Responsive Grid
```tsx
<s-grid columns="1" sm-columns="2" md-columns="3" lg-columns="4" gap="400">
<s-box border="base" borderRadius="base" padding="400">
<s-text>Column 1</s-text>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-text>Column 2</s-text>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-text>Column 3</s-text>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-text>Column 4</s-text>
</s-box>
</s-grid>
```
### Stack for Vertical Spacing
```tsx
<s-stack gap="600" direction="vertical">
<s-heading>Section Title</s-heading>
<s-stack gap="400" direction="vertical">
<s-text>Paragraph 1</s-text>
<s-text>Paragraph 2</s-text>
</s-stack>
<s-button variant="primary">Action</s-button>
</s-stack>
```
### Card with Header and Footer
```tsx
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Card Title</s-heading>
<s-divider />
<s-stack gap="300" direction="vertical">
<s-text>Card content goes here</s-text>
<s-text tone="subdued">Additional information</s-text>
</s-stack>
<s-divider />
<s-button-group>
<s-button variant="primary">Save</s-button>
<s-button>Cancel</s-button>
</s-button-group>
</s-stack>
</s-card>
```
### Stats Dashboard
```tsx
<s-grid columns="3" gap="400">
<s-box border="base" borderRadius="base" padding="400" background="bg-surface">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Total Sales</s-text>
<s-text variant="heading2xl">$12,345</s-text>
<s-badge tone="success">+12%</s-badge>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400" background="bg-surface">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Orders</s-text>
<s-text variant="heading2xl">234</s-text>
<s-badge tone="warning">-3%</s-badge>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400" background="bg-surface">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Customers</s-text>
<s-text variant="heading2xl">1,567</s-text>
<s-badge>Stable</s-badge>
</s-stack>
</s-box>
</s-grid>
```
## Spacing Scale
- `gap="050"` - 2px
- `gap="100"` - 4px
- `gap="200"` - 8px
- `gap="300"` - 12px
- `gap="400"` - 16px (default)
- `gap="500"` - 20px
- `gap="600"` - 24px
- `gap="800"` - 32px
- `gap="1000"` - 40px
## Best Practices
1. **Use s-page** - Always wrap content in s-page for proper layout
2. **Use s-section** - Provides consistent spacing between sections
3. **Responsive Grids** - Use responsive column props (sm, md, lg)
4. **Consistent Spacing** - Use Polaris spacing scale (gap="400")
5. **Card Organization** - Group related content in cards
6. **Stack Direction** - Use "vertical" for most content, "horizontal" for buttons
7. **Dividers** - Use sparingly to separate distinct sections
8. **Box for Styling** - Use s-box when you need background, border, padding
9. **Mobile First** - Design for mobile, enhance for desktop
10. **Semantic Structure** - Use proper heading hierarchy
---
**Remember**: Proper layout creates visual hierarchy and improves usability.

331
agents/patterns-expert.md Normal file
View File

@@ -0,0 +1,331 @@
---
name: polaris-patterns-expert
description: Expert in Polaris composition patterns. Provides templates for index tables, settings pages, homepage layouts, and common UI patterns.
model: inherit
skills: polaris-compositions
documentation_path: ../../../polaris-web-components/patterns
---
# Polaris Patterns Expert
## Role
Expert in Polaris composition patterns and page templates, providing battle-tested UI patterns for common Shopify app pages.
## Expertise
- Index/list page patterns
- Settings page layouts
- Homepage/dashboard designs
- Resource management patterns
- Empty state patterns
- Onboarding flows
## Available Pattern Categories
### Compositions (`patterns/compositions/`)
- **App Card** - Application summary cards
- **Resource List** - Filterable resource lists
- **Settings** - Settings page patterns
- **Callout Card** - Promotional cards
- **Account Connection** - Third-party integrations
- **Details** - Detailed information displays
- **Index Table** - Data tables with actions
- **Metrics Card** - Statistics and KPI cards
- **Setup Guide** - Onboarding checklists
- **Homepage** - App homepage layouts
- **Sticky Pagination** - Persistent pagination
- **Interstitial Nav** - Multi-step navigation
- **Footer Help** - Contextual help
- **Media Card** - Rich media cards
- **Empty State** - No content states
### Templates (`patterns/templates/`)
- **Settings Template** - Complete settings page
- **Homepage Template** - Complete homepage layout
## Common Patterns
### Index/Resource List Pattern
```tsx
<s-page heading="Products" primaryAction={{ content: "Add Product", url: "/products/new" }}>
{/* Stats Section */}
<s-section>
<s-grid columns="3">
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Total Products</s-text>
<s-text variant="heading2xl">{stats.total}</s-text>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Active</s-text>
<s-text variant="heading2xl">{stats.active}</s-text>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Draft</s-text>
<s-text variant="heading2xl">{stats.draft}</s-text>
</s-stack>
</s-box>
</s-grid>
</s-section>
{/* Filters and Search */}
<s-section>
<s-card>
<s-stack gap="300" alignment="space-between">
<s-search-field placeholder="Search products..." />
<s-select
label="Status"
options={[
{ label: "All", value: "all" },
{ label: "Active", value: "active" },
{ label: "Draft", value: "draft" },
]}
/>
</s-stack>
</s-card>
</s-section>
{/* Resource Table */}
<s-section>
<s-card>
<s-table>
<s-table-head>
<s-table-row>
<s-table-cell as="th">Product</s-table-cell>
<s-table-cell as="th">Status</s-table-cell>
<s-table-cell as="th">Price</s-table-cell>
<s-table-cell as="th">Actions</s-table-cell>
</s-table-row>
</s-table-head>
<s-table-body>
{products.map(product => (
<s-table-row key={product.id}>
<s-table-cell>{product.title}</s-table-cell>
<s-table-cell>
<s-badge tone={product.active ? "success" : undefined}>
{product.active ? "Active" : "Draft"}
</s-badge>
</s-table-cell>
<s-table-cell>${product.price}</s-table-cell>
<s-table-cell>
<s-button-group>
<s-button variant="plain">Edit</s-button>
<s-button variant="plain" tone="critical">Delete</s-button>
</s-button-group>
</s-table-cell>
</s-table-row>
))}
</s-table-body>
</s-table>
</s-card>
</s-section>
</s-page>
```
### Settings Page Pattern
```tsx
<s-page heading="Settings">
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>General Settings</s-heading>
<s-text-field
label="Store Name"
value={settings.storeName}
helpText="This appears in emails and your online store"
/>
<s-text-field
label="Contact Email"
type="email"
value={settings.email}
/>
<s-divider />
<s-heading>Notifications</s-heading>
<s-checkbox
label="Email notifications"
checked={settings.emailNotifications}
/>
<s-checkbox
label="Order updates"
checked={settings.orderUpdates}
/>
<s-divider />
<s-button-group>
<s-button variant="primary">Save Settings</s-button>
<s-button>Reset</s-button>
</s-button-group>
</s-stack>
</s-card>
</s-section>
</s-page>
```
### Dashboard/Homepage Pattern
```tsx
<s-page heading="Dashboard">
{/* Welcome Banner */}
<s-section>
<s-banner tone="info">
<s-text>Welcome back! You have 3 pending orders to fulfill.</s-text>
</s-banner>
</s-section>
{/* Key Metrics */}
<s-section>
<s-grid columns="4" gap="400">
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Today's Sales</s-text>
<s-text variant="heading2xl">$1,234</s-text>
<s-badge tone="success">+15%</s-badge>
</s-stack>
</s-box>
{/* More metrics... */}
</s-grid>
</s-section>
{/* Quick Actions */}
<s-section>
<s-grid columns="3" gap="400">
<s-card>
<s-stack gap="300" direction="vertical">
<s-heading>Orders</s-heading>
<s-text>12 orders need attention</s-text>
<s-button>View Orders</s-button>
</s-stack>
</s-card>
<s-card>
<s-stack gap="300" direction="vertical">
<s-heading>Products</s-heading>
<s-text>5 products low in stock</s-text>
<s-button>Manage Inventory</s-button>
</s-stack>
</s-card>
<s-card>
<s-stack gap="300" direction="vertical">
<s-heading>Customers</s-heading>
<s-text>23 new customers this week</s-text>
<s-button>View Customers</s-button>
</s-stack>
</s-card>
</s-grid>
</s-section>
{/* Recent Activity */}
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Recent Orders</s-heading>
<s-table>
{/* Order table */}
</s-table>
</s-stack>
</s-card>
</s-section>
</s-page>
```
### Empty State Pattern
```tsx
{products.length === 0 ? (
<s-section>
<s-card>
<s-empty-state
heading="No products yet"
image="https://cdn.shopify.com/s/files/1/0262/4071/2726/files/emptystate-files.png"
>
<s-text>Start by adding your first product to your store</s-text>
<s-button variant="primary" url="/products/new">
Add Product
</s-button>
</s-empty-state>
</s-card>
</s-section>
) : (
// Product list
)}
```
### Setup Guide/Onboarding Pattern
```tsx
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Get Started</s-heading>
<s-text tone="subdued">
Complete these steps to get your store ready
</s-text>
<s-divider />
<s-stack gap="300" direction="vertical">
<s-box padding="300" background={step1Done ? "bg-surface-success" : "bg-surface"}>
<s-stack gap="200" alignment="space-between">
<s-stack gap="200">
{step1Done && <s-icon source="checkmark" />}
<s-text>Add your first product</s-text>
</s-stack>
{!step1Done && <s-button variant="plain">Complete</s-button>}
</s-stack>
</s-box>
<s-box padding="300" background={step2Done ? "bg-surface-success" : "bg-surface"}>
<s-stack gap="200" alignment="space-between">
<s-stack gap="200">
{step2Done && <s-icon source="checkmark" />}
<s-text>Configure shipping</s-text>
</s-stack>
{!step2Done && <s-button variant="plain">Complete</s-button>}
</s-stack>
</s-box>
<s-box padding="300" background={step3Done ? "bg-surface-success" : "bg-surface"}>
<s-stack gap="200" alignment="space-between">
<s-stack gap="200">
{step3Done && <s-icon source="checkmark" />}
<s-text>Set up payments</s-text>
</s-stack>
{!step3Done && <s-button variant="plain">Complete</s-button>}
</s-stack>
</s-box>
</s-stack>
</s-stack>
</s-card>
</s-section>
```
## Pattern Reference
For complete pattern documentation, reference:
- `polaris-web-components/patterns/compositions/` - Individual composition patterns
- `polaris-web-components/patterns/templates/` - Complete page templates
## Best Practices
1. **Follow Established Patterns** - Use proven patterns for common pages
2. **Consistent Layouts** - Maintain consistency across your app
3. **Progressive Disclosure** - Show advanced options only when needed
4. **Clear Hierarchy** - Use headings and sections to organize content
5. **Actionable CTAs** - Make primary actions obvious
6. **Empty States** - Always provide guidance when no data exists
7. **Loading States** - Show skeleton loaders during data fetch
8. **Error Handling** - Display clear, actionable error messages
9. **Mobile Responsive** - All patterns should work on mobile
10. **Accessibility** - Ensure keyboard navigation and screen reader support
---
**Remember**: Established patterns improve UX by meeting user expectations and reducing cognitive load.

69
plugin.lock.json Normal file
View File

@@ -0,0 +1,69 @@
{
"$schema": "internal://schemas/plugin.lock.v1.json",
"pluginId": "gh:sarojpunde/shopify-dev-toolkit-claude-plugins:shopify-polaris",
"normalized": {
"repo": null,
"ref": "refs/tags/v20251128.0",
"commit": "b4b2da636a837f4e3581222fb723b7cb6658bb6f",
"treeHash": "8fe7ab6d9fb7d4848945468d9fc018815e51b2ec15a65c59db6766a3e353e8f8",
"generatedAt": "2025-11-28T10:28:09.080705Z",
"toolVersion": "publish_plugins.py@0.2.0"
},
"origin": {
"remote": "git@github.com:zhongweili/42plugin-data.git",
"branch": "master",
"commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390",
"repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data"
},
"manifest": {
"name": "polaris-component-expert",
"description": "Polaris Web Components expert with access to full component library. Provides guidance on using actions, forms, feedback, media, structure, and text components.",
"version": "1.0.0"
},
"content": {
"files": [
{
"path": "README.md",
"sha256": "635913d598c4f777abc6adec8376c6cfadf51926bb13f1bf33551069678991e7"
},
{
"path": "agents/forms-specialist.md",
"sha256": "ab8f3e7b1de5458c4c13caee0af8b945267f5608dc6af1276c619eb7102901a3"
},
{
"path": "agents/layout-specialist.md",
"sha256": "0e69ef6a1dd2dd0aec6748567fa53ec70cd48860dc13454b1f2726e04f406355"
},
{
"path": "agents/component-expert.md",
"sha256": "298ee9c277e4ac4c157a8fc2d671876929d5c145366f9f4ea8563a05debbadef"
},
{
"path": "agents/patterns-expert.md",
"sha256": "74035c244cb893f55acdc7e481bc5b17f89207b6477f0e0d70fee2969be66d6e"
},
{
"path": "agents/app-bridge-specialist.md",
"sha256": "aa2cc009811c67940386d824855633b534749a93b5b68d6eb4f890c1f99abe3c"
},
{
"path": ".claude-plugin/plugin.json",
"sha256": "2e869085345ae1fdd48d3508e1bc8e2e4787e3f3db9aded65c4d89b50a65186f"
},
{
"path": "skills/polaris-fundamentals/SKILL.md",
"sha256": "e6427741c862a60311430055fd1bfad773029080ef07c36bc76afd209905f2a2"
},
{
"path": "skills/polaris-compositions/SKILL.md",
"sha256": "837e820bea36120d3a9d34d2a4cf7e4131d21b15bf8da225fa130e38a669e12d"
}
],
"dirSha256": "8fe7ab6d9fb7d4848945468d9fc018815e51b2ec15a65c59db6766a3e353e8f8"
},
"security": {
"scannedAt": null,
"scannerVersion": null,
"flags": []
}
}

422
skills/polaris-compositions/SKILL.md Normal file
View File

@@ -0,0 +1,422 @@
---
name: polaris-compositions
description: Polaris composition patterns and page templates for common Shopify app layouts. Provides index tables, settings pages, dashboards, and resource management patterns. Auto-invoked when building page layouts.
allowed-tools: [Read, Grep, Glob]
documentation_path: ../../../polaris-web-components/patterns
---
# Polaris Compositions Skill
## Purpose
Provides complete page templates and composition patterns for common Shopify app layouts using Polaris Web Components.
## When This Skill Activates
- Creating new pages or views
- Building index/list pages
- Implementing settings interfaces
- Designing dashboards
- Creating resource management UIs
## Available Patterns
Reference: `polaris-web-components/patterns/compositions/`
### Composition Patterns
1. **App Card** - Application summary cards with actions
2. **Resource List** - Filterable, sortable resource lists
3. **Settings** - Settings page layouts with sections
4. **Callout Card** - Promotional or informational cards
5. **Account Connection** - Third-party service integrations
6. **Details** - Detailed information displays
7. **Index Table** - Data tables with bulk actions
8. **Metrics Card** - Statistics and KPI displays
9. **Setup Guide** - Onboarding checklists
10. **Homepage** - App homepage/dashboard layouts
11. **Sticky Pagination** - Persistent pagination controls
12. **Interstitial Nav** - Multi-step navigation flows
13. **Footer Help** - Contextual help sections
14. **Media Card** - Rich media content cards
15. **Empty State** - No content placeholders
## Complete Page Templates
### Index/List Page Template
**Use for**: Products, Orders, Customers, Collections
```tsx
<s-page
heading="Products"
primaryAction={{ content: "Add Product", url: "/products/new" }}
>
{/* Stats Cards */}
<s-section>
<s-grid columns="1" md-columns="3" gap="400">
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Total Products</s-text>
<s-text variant="heading2xl">{stats.total}</s-text>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Active</s-text>
<s-text variant="heading2xl">{stats.active}</s-text>
<s-badge tone="success">+12%</s-badge>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Draft</s-text>
<s-text variant="heading2xl">{stats.draft}</s-text>
</s-stack>
</s-box>
</s-grid>
</s-section>
{/* Filters */}
<s-section>
<s-card>
<s-stack gap="300" alignment="space-between">
<s-search-field
placeholder="Search products..."
value={searchQuery}
/>
<s-select
label="Status"
options={[
{ label: "All", value: "all" },
{ label: "Active", value: "active" },
{ label: "Draft", value: "draft" },
]}
/>
</s-stack>
</s-card>
</s-section>
{/* Data Table */}
<s-section>
{products.length === 0 ? (
<s-card>
<s-empty-state
heading="No products found"
image="https://cdn.shopify.com/..."
>
<s-text>Try adjusting your filters or add a new product</s-text>
<s-button variant="primary" url="/products/new">
Add Product
</s-button>
</s-empty-state>
</s-card>
) : (
<s-card>
<s-table>
<s-table-head>
<s-table-row>
<s-table-cell as="th">Product</s-table-cell>
<s-table-cell as="th">Status</s-table-cell>
<s-table-cell as="th">Inventory</s-table-cell>
<s-table-cell as="th">Price</s-table-cell>
<s-table-cell as="th">Actions</s-table-cell>
</s-table-row>
</s-table-head>
<s-table-body>
{products.map(product => (
<s-table-row key={product.id}>
<s-table-cell>
<s-stack gap="200">
<s-thumbnail source={product.image} size="small" />
<s-text>{product.title}</s-text>
</s-stack>
</s-table-cell>
<s-table-cell>
<s-badge tone={product.active ? "success" : undefined}>
{product.active ? "Active" : "Draft"}
</s-badge>
</s-table-cell>
<s-table-cell>{product.inventory} in stock</s-table-cell>
<s-table-cell>${product.price}</s-table-cell>
<s-table-cell>
<s-button-group>
<s-button variant="plain" url={`/products/${product.id}`}>
Edit
</s-button>
<s-button variant="plain" tone="critical">
Delete
</s-button>
</s-button-group>
</s-table-cell>
</s-table-row>
))}
</s-table-body>
</s-table>
{/* Pagination */}
<s-box padding="400">
<s-stack gap="200" alignment="center">
<s-button disabled={page === 1}>Previous</s-button>
<s-text>Page {page} of {totalPages}</s-text>
<s-button disabled={page === totalPages}>Next</s-button>
</s-stack>
</s-box>
</s-card>
)}
</s-section>
</s-page>
```
### Settings Page Template
```tsx
<s-page heading="Settings">
{/* General Settings */}
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>General</s-heading>
<s-text-field
label="Store Name"
value={settings.storeName}
helpText="This appears in your emails and online store"
/>
<s-text-field
label="Contact Email"
type="email"
value={settings.contactEmail}
/>
<s-text-field
label="Customer Support Email"
type="email"
value={settings.supportEmail}
/>
</s-stack>
</s-card>
</s-section>
{/* Notifications */}
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Notifications</s-heading>
<s-text tone="subdued">
Choose which notifications you want to receive
</s-text>
<s-divider />
<s-checkbox
label="Email notifications"
checked={settings.emailNotifications}
helpText="Receive updates via email"
/>
<s-checkbox
label="Order notifications"
checked={settings.orderNotifications}
helpText="Get notified about new orders"
/>
<s-checkbox
label="Customer messages"
checked={settings.customerMessages}
helpText="Receive customer inquiries"
/>
</s-stack>
</s-card>
</s-section>
{/* Advanced Settings */}
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Advanced</s-heading>
<s-banner tone="warning">
<s-text>
These settings can affect your store's functionality.
Change with caution.
</s-text>
</s-banner>
<s-divider />
<s-checkbox
label="Enable API access"
checked={settings.apiEnabled}
/>
<s-checkbox
label="Debug mode"
checked={settings.debugMode}
/>
</s-stack>
</s-card>
</s-section>
{/* Save Section */}
<s-section>
<s-stack gap="300" alignment="trailing">
<s-button>Reset to Defaults</s-button>
<s-button variant="primary">Save Settings</s-button>
</s-stack>
</s-section>
</s-page>
```
### Dashboard/Homepage Template
```tsx
<s-page heading="Dashboard">
{/* Welcome Message */}
<s-section>
<s-banner tone="info">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Welcome back!</s-text>
<s-text>
You have 3 orders to fulfill and 2 customer messages.
</s-text>
</s-stack>
</s-banner>
</s-section>
{/* Key Metrics */}
<s-section>
<s-grid columns="1" md-columns="2" lg-columns="4" gap="400">
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Today's Sales</s-text>
<s-text variant="heading2xl">$2,453</s-text>
<s-badge tone="success">+15% from yesterday</s-badge>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Orders</s-text>
<s-text variant="heading2xl">34</s-text>
<s-badge>5 pending</s-badge>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Conversion Rate</s-text>
<s-text variant="heading2xl">3.2%</s-text>
<s-badge tone="success">+0.3%</s-badge>
</s-stack>
</s-box>
<s-box border="base" borderRadius="base" padding="400">
<s-stack gap="200" direction="vertical">
<s-text variant="headingMd">Average Order</s-text>
<s-text variant="heading2xl">$72.15</s-text>
<s-badge tone="warning">-2%</s-badge>
</s-stack>
</s-box>
</s-grid>
</s-section>
{/* Quick Actions */}
<s-section>
<s-grid columns="1" md-columns="3" gap="400">
<s-card>
<s-stack gap="300" direction="vertical">
<s-heading>Orders</s-heading>
<s-text tone="subdued">5 orders need fulfillment</s-text>
<s-button url="/orders">Manage Orders</s-button>
</s-stack>
</s-card>
<s-card>
<s-stack gap="300" direction="vertical">
<s-heading>Products</s-heading>
<s-text tone="subdued">3 products low in stock</s-text>
<s-button url="/products">View Inventory</s-button>
</s-stack>
</s-card>
<s-card>
<s-stack gap="300" direction="vertical">
<s-heading>Customers</s-heading>
<s-text tone="subdued">2 messages waiting</s-text>
<s-button url="/customers">View Messages</s-button>
</s-stack>
</s-card>
</s-grid>
</s-section>
{/* Recent Activity */}
<s-section>
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Recent Orders</s-heading>
<s-table>
<s-table-head>
<s-table-row>
<s-table-cell as="th">Order</s-table-cell>
<s-table-cell as="th">Customer</s-table-cell>
<s-table-cell as="th">Total</s-table-cell>
<s-table-cell as="th">Status</s-table-cell>
</s-table-row>
</s-table-head>
<s-table-body>
{recentOrders.map(order => (
<s-table-row key={order.id}>
<s-table-cell>#{order.number}</s-table-cell>
<s-table-cell>{order.customer}</s-table-cell>
<s-table-cell>${order.total}</s-table-cell>
<s-table-cell>
<s-badge tone={order.fulfilled ? "success" : "warning"}>
{order.fulfilled ? "Fulfilled" : "Pending"}
</s-badge>
</s-table-cell>
</s-table-row>
))}
</s-table-body>
</s-table>
</s-stack>
</s-card>
</s-section>
</s-page>
```
## Pattern Components Reference
For detailed pattern documentation, see:
- `polaris-web-components/patterns/compositions/` - All composition patterns
- `polaris-web-components/patterns/templates/` - Complete page templates
### Quick Pattern Reference
| Pattern | File | Use Case |
|---------|------|----------|
| Index Table | `index-table.md` | Product lists, order lists |
| Settings | `settings.md` | App configuration pages |
| Homepage | `homepage.md` | Dashboard layouts |
| Empty State | `empty-state.md` | No content states |
| Metrics Card | `metrics-card.md` | KPI displays |
| Resource List | `resource-list.md` | Filterable lists |
| Setup Guide | `setup-guide.md` | Onboarding flows |
## Best Practices
1. **Follow Templates** - Use established templates for common pages
2. **Consistent Layout** - Maintain consistent structure across pages
3. **Progressive Disclosure** - Show advanced options only when needed
4. **Clear Hierarchy** - Use sections to organize content logically
5. **Actionable CTAs** - Make primary actions obvious
6. **Empty States** - Always provide guidance when no data exists
7. **Loading States** - Show skeletons during data fetch
8. **Error Handling** - Display clear, actionable error messages
9. **Mobile Responsive** - All patterns work on mobile devices
10. **Accessibility** - Ensure keyboard navigation and screen readers work
---
**Remember**: Using established patterns improves UX consistency and reduces development time.

315
skills/polaris-fundamentals/SKILL.md Normal file
View File

@@ -0,0 +1,315 @@
---
name: polaris-fundamentals
description: Core Polaris Web Components fundamentals including component library structure, design tokens, responsive patterns, and SSR compatibility. Auto-invoked when working with Polaris components.
allowed-tools: [Read, Grep, Glob]
documentation_path: ../../../polaris-web-components
---
# Polaris Fundamentals Skill
## Purpose
Provides foundational knowledge of Polaris Web Components, including setup, component categories, design tokens, and best practices.
## When This Skill Activates
- Working with Polaris Web Components
- Building Shopify app UIs
- Implementing design system patterns
- Choosing components for specific use cases
## Core Concepts
### Component Categories
Polaris Web Components are organized into six categories:
**1. Actions** - Interactive elements that trigger actions
- Buttons, links, icon buttons, button groups
**2. Forms** - Input and selection components
- Text fields, checkboxes, selects, file uploads, color pickers
**3. Feedback** - Status and notification components
- Banners, toasts, progress bars, spinners, skeletons
**4. Media** - Visual content components
- Avatars, icons, thumbnails, video thumbnails
**5. Structure** - Layout and organization components
- Pages, cards, sections, boxes, grids, stacks, tables
**6. Titles and Text** - Typography components
- Headings, text, paragraphs, badges, chips
### Design Tokens
#### Spacing Scale
```tsx
gap="050" // 2px
gap="100" // 4px
gap="200" // 8px
gap="300" // 12px
gap="400" // 16px (default)
gap="500" // 20px
gap="600" // 24px
gap="800" // 32px
gap="1000" // 40px
gap="1600" // 64px
```
#### Background Colors
```tsx
background="bg-surface" // Default surface
background="bg-surface-secondary" // Secondary surface
background="bg-surface-tertiary" // Tertiary surface
background="bg-surface-success" // Success state
background="bg-surface-warning" // Warning state
background="bg-surface-critical" // Error state
```
#### Border Options
```tsx
border="base" // Default border
border="success" // Success border
border="warning" // Warning border
border="critical" // Error border
```
#### Border Radius
```tsx
borderRadius="base" // 4px
borderRadius="large" // 8px
borderRadius="full" // 50% (circular)
```
#### Text Tones
```tsx
tone="subdued" // Secondary text
tone="success" // Success message
tone="warning" // Warning message
tone="critical" // Error message
```
### Typography Variants
```tsx
variant="heading3xl" // Page titles
variant="heading2xl" // Section headers
variant="headingXl" // Card titles
variant="headingLg" // Subsection headers
variant="headingMd" // Card headers
variant="headingSm" // Small headers
variant="bodyLg" // Large body text
variant="bodyMd" // Default body text (default)
variant="bodySm" // Small body text
```
### Responsive Breakpoints
```tsx
// Mobile first approach
columns="1" // Mobile (default)
sm-columns="2" // Small devices (≥577px)
md-columns="3" // Medium devices (≥769px)
lg-columns="4" // Large devices (≥1025px)
// Example usage
<s-grid columns="1" md-columns="2" lg-columns="4">
<div>Column 1</div>
<div>Column 2</div>
<div>Column 3</div>
<div>Column 4</div>
</s-grid>
```
## React Hydration (SSR Apps)
### ⚠️ CRITICAL: Event Handler Pattern
**NEVER use inline event handlers** - they cause hydration mismatches in SSR apps.
```tsx
// ❌ WRONG - Hydration mismatch
<s-button onclick={handleClick}>Click</s-button>
// ✅ CORRECT - Use data attributes + useEffect
<s-button data-my-button>Click</s-button>
useEffect(() => {
const button = document.querySelector('[data-my-button]');
if (button) {
button.addEventListener('click', handleClick);
}
return () => button?.removeEventListener('click', handleClick);
}, []);
```
## Common Component Patterns
### Button Variants
```tsx
<s-button>Default</s-button>
<s-button variant="primary">Primary</s-button>
<s-button variant="destructive">Delete</s-button>
<s-button variant="plain">Plain</s-button>
<s-button size="slim">Small</s-button>
<s-button loading>Loading</s-button>
<s-button disabled>Disabled</s-button>
```
### Text Field States
```tsx
<s-text-field
label="Product Title"
value={title}
error={errors.title} // Show error
disabled={isDisabled} // Disable input
required // Mark required
helpText="Customer-facing" // Help text
placeholder="Enter title" // Placeholder
/>
```
### Card Structure
```tsx
<s-card>
<s-stack gap="400" direction="vertical">
<s-heading>Card Title</s-heading>
<s-divider />
<s-text>Card content</s-text>
<s-divider />
<s-button-group>
<s-button variant="primary">Save</s-button>
<s-button>Cancel</s-button>
</s-button-group>
</s-stack>
</s-card>
```
### Loading Pattern
```tsx
{isLoading ? (
<s-card>
<s-stack gap="400" direction="vertical">
<s-skeleton-display-text />
<s-skeleton-display-text />
<s-skeleton-display-text />
</s-stack>
</s-card>
) : (
<s-card>{/* Actual content */}</s-card>
)}
```
### Empty State Pattern
```tsx
{items.length === 0 ? (
<s-empty-state
heading="No items yet"
image="https://cdn.shopify.com/..."
>
<s-text>Get started by adding your first item</s-text>
<s-button variant="primary">Add Item</s-button>
</s-empty-state>
) : (
// Item list
)}
```
## Page Structure
### Standard Page Layout
```tsx
<s-page heading="Page Title">
<s-section>
{/* First section */}
</s-section>
<s-section>
{/* Second section */}
</s-section>
</s-page>
```
### Page with Primary Action
```tsx
<s-page
heading="Products"
primaryAction={{
content: "Add Product",
url: "/products/new"
}}
>
{/* Page content */}
</s-page>
```
## Accessibility
### Semantic HTML
```tsx
<s-heading as="h1">Main Title</s-heading>
<s-heading as="h2">Section Title</s-heading>
<s-text as="p">Paragraph text</s-text>
```
### ARIA Labels
```tsx
<s-icon-button
icon="delete"
aria-label="Delete product"
/>
<s-search-field
aria-label="Search products"
placeholder="Search..."
/>
```
### Keyboard Navigation
- All interactive elements are keyboard accessible
- Use Tab to navigate
- Enter/Space to activate buttons
- Escape to close modals
## Best Practices
1. **Use Design Tokens** - Never hardcode colors, spacing, or typography
2. **Mobile First** - Start with mobile layout, enhance for desktop
3. **Semantic HTML** - Use the `as` prop for proper HTML elements
4. **Loading States** - Always show skeleton loaders during data fetch
5. **Empty States** - Provide guidance when no data exists
6. **Error Handling** - Use inline errors for form validation
7. **Accessibility** - Ensure keyboard navigation and ARIA labels
8. **Consistent Spacing** - Use Polaris spacing scale (gap="400")
9. **SSR Compatible** - Use data attributes for event handlers
10. **Follow Patterns** - Use established Polaris patterns
## Component Selection Guide
| Need | Component | Example |
|------|-----------|---------|
| Primary action | `<s-button variant="primary">` | Save, Submit |
| Secondary action | `<s-button>` | Cancel, Back |
| Destructive action | `<s-button variant="destructive">` | Delete, Remove |
| Page container | `<s-page>` | All pages |
| Content container | `<s-card>` | Forms, data displays |
| Text input | `<s-text-field>` | Title, description |
| Selection | `<s-select>` | Category, status |
| Multiple choices | `<s-checkbox>` | Features, options |
| Success message | `<s-banner tone="success">` | Saved successfully |
| Error message | `<s-banner tone="critical">` | Failed to save |
| Status indicator | `<s-badge>` | Active, Draft |
| Data table | `<s-table>` | Products, orders |
| Vertical spacing | `<s-stack direction="vertical">` | Form fields |
| Horizontal layout | `<s-grid>` | Dashboard cards |
## Documentation Reference
For complete component documentation, see:
- `polaris-web-components/components/` - All component docs
- `polaris-web-components/patterns/` - Composition patterns
- `polaris-web-components/using-polaris-web-components.md` - Setup guide
---
**Remember**: Polaris ensures your app matches Shopify's design system and provides a consistent, accessible user experience.