shopify-polaris-app-home

Generate TypeScript/Preact code with Polaris web components for Shopify admin app-home extensions.

491|60|Updated Apr 1, 2026
One-click install
npx skills add https://github.com/Shopify/Shopify-AI-Toolkit --skill shopify-polaris-app-home
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shopify-polaris-app-home
Source: https://github.com/Shopify/Shopify-AI-Toolkit/tree/main/skills/shopify-polaris-app-home
Command: npx skills add https://github.com/Shopify/Shopify-AI-Toolkit --skill shopify-polaris-app-home

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Developers need a reliable way to create embedded Shopify admin interfaces using Polaris components, while ensuring code is searched, validated, and conforms to Shopify standards.

Core Features & Use Cases

  • Automated Documentation Search: Runs scripts/search_docs.mjs to fetch up‑to‑date component docs before coding.
  • Code Generation with Polaris Web Components: Generates TypeScript/Preact code using s- prefixed Polaris web components.
  • Validation Loop: Writes code to a temporary file and validates it with scripts/validate.mjs, retrying up to three times on errors.
  • Tool Coordination: Orchestrates Bash calls, artifact tracking, and client metadata for seamless CI/CD integration. Use it to quickly scaffold an app‑home page, settings screen, or any Polaris UI pattern within a Shopify app.

Quick Start

Ask the skill to create a Polaris app‑home page that includes a settings section with toggles.

Frequently Asked Questions about shopify-polaris-app-home

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create embedded Shopify admin UI with Polaris components?

To create embedded Shopify admin UI, this Skill generates TypeScript with Preact code using s- prefixed Polaris web components. It fetches up-to-date component documentation first, then outputs validated code ready for your app-home extensions.

What's the best way to build an app-home extension for a Shopify app?

Building an app-home extension is handled by orchestrating Bash calls to fetch Polaris documentation and validate the generated TypeScript code. It performs a validation loop, retrying up to three times to ensure the UI conforms to Shopify standards.

Does the Polaris UI code generation process validate TypeScript automatically?

Yes, Polaris UI code generation includes an automated validation loop. It writes the generated Preact code to a temporary file and validates it using a Node script, retrying up to three times on errors to ensure correctness.

Do I need Node scripts to scaffold a Shopify Polaris settings screen?

Yes, you need Node scripts and the Bash tool to scaffold a Shopify Polaris settings screen. The Skill executes Node scripts to search component documentation and perform the validation loops required for generating accurate Preact code.

How does documentation search work when generating Polaris web components?

Documentation search works by running a dedicated Node script before coding to fetch the latest Polaris web component docs. This ensures the generated TypeScript and Preact code uses the most current s- prefixed component properties and patterns.

Can I use Preact and TypeScript for Shopify admin app-home development?

Yes, you can use Preact and TypeScript for Shopify admin app-home development. This Skill specifically generates TypeScript code with Preact to build Polaris web components, integrating artifact tracking and client metadata for CI/CD workflows.