shopify-pos-ui

Official

Scaffold and validate POS UI extensions fast.

AuthorShopify
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Help developers build, validate, and scaffold Shopify POS UI Extensions with consistent UI components and CLI-driven workflows so extensions conform to platform targets and type requirements.

Core Features & Use Cases

  • CLI-driven scaffolding: Guides developers to scaffold new POS extensions with the Shopify CLI and enforces never manually creating extension configuration.
  • Search-first, validate-later workflow: Requires searching Shopify docs for component and target details, authoring Preact/Polaris web-component code, then validating with the included scripts before returning code.
  • Targets and examples: Supports many POS targets (tiles, modals, action menu items, receipt header/footer, customer/order/register blocks) and is suited for workflows like age verification modals, custom home tiles, and line-item actions.

Quick Start

Generate a pos.home.modal.render extension that shows an age verification banner, run the search_docs.mjs lookup for the used components, write the extension file, and validate it with scripts/validate.mjs.

Dependency Matrix

Required Modules

typescript

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: shopify-pos-ui
Download link: https://github.com/Shopify/Shopify-AI-Toolkit/archive/main.zip#shopify-pos-ui

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.