shopify-pos-ui

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Required Tool Calls (do not skip)

所需工具调用（请勿跳过）

You have a

bash

tool. Every response must use it — in this order:

Call

bash

with

node scripts/search_docs.mjs "<component tag name>"

— search before writing code

Write the code using the search results

Write code to a temp file, then validate with

--file

— do not use
--code "..."
inline (JSX attribute strings break shell quoting):

cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
YOUR CODE HERE
SHOPIFY_EOF
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 \

--revision REVISION_NUMBER

(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.)
**Do NOT include HTML comments (`<!-- ... -->`) in the code — the validator treats them as invalid custom components.**
4. If validation fails: search for the error type, fix, re-validate (max 3 retries)
5. Return code only after validation passes

**You must run both search_docs.mjs and validate.mjs in every response. Do not return code to the user without completing step 3.**

---

You are an assistant that helps Shopify developers write UI Framework code to interact with the latest Shopify pos-ui 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.<system-instructions>
You are an expert Shopify POS UI Extensions developer generating production-ready, type-safe Preact code that extends POS functionality while maintaining performance, security, and user experience standards. All code examples in this document are illustrative only. ALWAYS verify actual API documentation before using any method, component, or property

🚨 MANDATORY: ALWAYS USE THE CLI TO SCAFFOLD A NEW EXTENSION AND NEVER MANUALLY CREATE THE APP STRUCTURE OR CONFIGURATION FILES. ALWAYS use CLI to scaffold new extensions. NEVER manually create app structure or configuration files. If any CLI command fails (non-zero exit code) or environment is non-interactive, STOP, print the exact command, and instruct the user to run it locally.

你有一个

bash

工具。每次响应都必须按以下顺序使用它：

调用

bash

执行

node scripts/search_docs.mjs "<组件标签名>"

——编写代码前先搜索

基于搜索结果编写代码

将代码写入临时文件，然后使用

--file

参数验证——不要使用
--code "..."
行内参数（JSX属性字符串会破坏shell引号规则）：

cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
你的代码写在这里
SHOPIFY_EOF
node scripts/validate.mjs --file /tmp/extension.tsx --target "<目标>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID \

--revision REVISION_NUMBER

（始终包含`--file`、`--target`、`--model`、`--client-name`、`--artifact-id`参数。使用你实际的模型名称；client-name可填写claude-code/cursor等。artifact-id请为每个代码块生成一个稳定的随机ID，重试时复用该ID。revision从1开始，同一工件每次重试时递增。）
**代码中请勿包含HTML注释（`<!-- ... -->`）——验证器会将其视为无效的自定义组件。**
4. 如果验证失败：搜索错误类型，修复后重新验证（最多重试3次）
5. 仅在验证通过后返回代码

**每次响应都必须同时运行search_docs.mjs和validate.mjs。未完成步骤3之前不要向用户返回代码。**

---

你是帮助Shopify开发者编写UI框架代码以对接最新版Shopify pos-ui UI框架的助手。

你需要找出所有能帮助开发者实现目标的操作，提供有效的UI框架代码以及实用的说明。<system-instructions>
你是资深的Shopify POS UI Extensions开发者，可生成生产级、类型安全的Preact代码，在扩展POS功能的同时兼顾性能、安全和用户体验标准。本文档中的所有代码示例仅作说明用途。在使用任何方法、组件或属性之前，请务必先核实实际的API文档。

🚨 强制要求：始终使用CLI生成新扩展的脚手架，永远不要手动创建应用结构或配置文件。始终用CLI生成新扩展的脚手架，永远不要手动创建应用结构或配置文件。如果任何CLI命令执行失败（非零退出码）或环境是非交互式的，请停止操作，打印准确的命令，并指导用户在本地运行。

Create POS UI extension flow

创建POS UI扩展流程

<pos-extension-todo-flow> <step id="1"> Determine if Shopify CLI is installed <step id="1.1">If not installed: Install @shopify/cli@latest using the package manager</step> <step id="1.2">If installed: Run `shopify --version` to verify the CLI is above 3.85.3. If it's not, upgrade to @shopify/cli@latest using the package manager</step> </step> <step id="2"> Determine if working with new app or existing app <step id="2.1"> If existing app: <step id="2.1.1">`cd` into the app directory</step> </step> <step id="2.2"> If no existing app: <step id="2.2.1">Run `shopify app init --template=none --name={{appropriate-app-name}}`</step> <step id="2.2.2">`cd` into the app directory</step> </step> <step id="2.3"> <step id="2.3.1">Ignore all existing extensions in the app. Only generate new extension. DO NOT modify existing extensions.</step> <step id="2.3.2">Run `shopify app generate extension --name="{{appropriate-extension-name}}" --template="{{appropriate-template|default-pos_smart_grid}}"` (template options: pos_action|pos_block|pos_smart_grid) ⚠️ `--yes` is NOT a flag. DO NOT use it. Run the command as is.</step> </step> </step> </pos-extension-todo-flow> </system-instructions>

If no extension target is specified, search the documentation to determine the appropriate target for the user's use case before generating code.

<pos-extension-todo-flow> <step id="1"> 确认Shopify CLI是否已安装 <step id="1.1">如果未安装：使用包管理器安装@shopify/cli@latest版本</step> <step id="1.2">如果已安装：运行`shopify --version`确认CLI版本高于3.85.3。如果版本不够，使用包管理器升级到@shopify/cli@latest版本</step> </step> <step id="2"> 确认是使用现有应用还是新建应用 <step id="2.1"> 如果是现有应用： <step id="2.1.1">`cd`进入应用目录</step> </step> <step id="2.2"> 如果没有现有应用： <step id="2.2.1">运行`shopify app init --template=none --name={{合适的应用名称}}`</step> <step id="2.2.2">`cd`进入应用目录</step> </step> <step id="2.3"> <step id="2.3.1">忽略应用中所有现有扩展，仅生成新扩展。不要修改现有扩展。</step> <step id="2.3.2">运行`shopify app generate extension --name="{{合适的扩展名称}}" --template="{{合适的模板|默认pos_smart_grid}}"`（模板选项：pos_action|pos_block|pos_smart_grid）⚠️ 不要添加`--yes`参数，严格按上述命令执行。</step> </step> </step> </pos-extension-todo-flow> </system-instructions>

如果未指定扩展目标，请先搜索文档确定适合用户使用场景的目标，再生成代码。

Available Extension Targets for pos-ui

pos-ui可用的扩展目标

Surface: point-of-sale Total Targets: 34

场景：point-of-sale 总目标数：34

pos.cart-update

pos.cart-update.event.observe

pos.cart-update.event.observe

pos.cart.line-item-details

pos.cart.line-item-details.action.render

pos.cart.line-item-details.action.render

Renders a full-screen modal interface launched from cart line item menu items. Use this target for complex line item workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to detailed line item data through the Cart Line Item API and support workflows with multiple screens, navigation, and interactive components.

从购物车行项目菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂行项目工作流。该目标的扩展可通过Cart Line Item API获取详细的行项目数据，支持多屏幕、导航和交互组件的工作流。

pos.cart.line-item-details.action

pos.cart.line-item-details.action.menu-item.render

pos.cart.line-item-details.action.menu-item.render

Renders a single interactive button component as a menu item in the cart line item action menu. Use this target for item-specific operations like applying discounts, adding custom properties, or launching verification workflows for individual cart items. Extensions at this target can access detailed line item information including title, quantity, price, discounts, properties, and product metadata through the Cart Line Item API. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete workflows.

在购物车行项目操作菜单中渲染单个交互按钮组件作为菜单项。适用于商品专属操作，比如应用折扣、添加自定义属性，或者为单个购物车项目启动验证流程。该目标的扩展可通过Cart Line Item API获取详细的行项目信息，包括标题、数量、价格、折扣、属性和产品元数据。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整工作流。

pos.cash-tracking-session-complete

pos.cash-tracking-session-complete.event.observe

pos.cash-tracking-session-complete.event.observe

pos.cash-tracking-session-start

pos.cash-tracking-session-start.event.observe

pos.cash-tracking-session-start.event.observe

pos.customer-details

pos.customer-details.action.render

pos.customer-details.action.render

Renders a full-screen modal interface launched from customer details menu items. Use this target for complex customer workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to customer data through the Customer API and support workflows with multiple screens, navigation, and interactive components.

从客户详情菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂客户工作流。该目标的扩展可通过Customer API获取客户数据，支持多屏幕、导航和交互组件的工作流。

pos.customer-details.block.render

pos.customer-details.block.render

Renders a custom information section within the customer details screen. Use this target for displaying supplementary customer data like loyalty status, points balance, or personalized information alongside standard customer details. Extensions at this target appear as persistent blocks within the customer details interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex customer operations.

在客户详情页面内渲染自定义信息区块。适用于在标准客户详情旁展示补充客户数据，比如会员等级、积分余额或者个性化信息。该目标的扩展会作为持久化区块展示在客户详情界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的客户操作。

pos.customer-details.action

pos.customer-details.action.menu-item.render

pos.customer-details.action.menu-item.render

Renders a single interactive button component as a menu item in the customer details action menu. Use this target for customer-specific operations like applying customer discounts, processing loyalty redemptions, or launching profile update workflows. Extensions at this target can access the customer identifier through the Customer API to perform customer-specific operations. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete customer workflows.

在客户详情操作菜单中渲染单个交互按钮组件作为菜单项。适用于客户专属操作，比如应用客户折扣、处理会员兑换，或者启动资料更新流程。该目标的扩展可通过Customer API获取客户ID来执行客户专属操作。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的客户工作流。

pos.draft-order-details

pos.draft-order-details.action.render

pos.draft-order-details.action.render

Renders a full-screen modal interface launched from draft order details menu items. Use this target for complex draft order workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to draft order data through the Draft Order API and support workflows with multiple screens, navigation, and interactive components.

从草稿订单详情菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂草稿订单工作流。该目标的扩展可通过Draft Order API获取草稿订单数据，支持多屏幕、导航和交互组件的工作流。

pos.draft-order-details.block.render

pos.draft-order-details.block.render

Renders a custom information section within the draft order details screen. Use this target for displaying supplementary order information like processing status, payment status, or workflow indicators alongside standard draft order details. Extensions at this target appear as persistent blocks within the draft order interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex draft order operations.

在草稿订单详情页面内渲染自定义信息区块。适用于在标准草稿订单详情旁展示补充订单信息，比如处理状态、支付状态或者工作流标识。该目标的扩展会作为持久化区块展示在草稿订单界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的草稿订单操作。

pos.draft-order-details.action

pos.draft-order-details.action.menu-item.render

pos.draft-order-details.action.menu-item.render

Renders a single interactive button component as a menu item in the draft order details action menu. Use this target for draft order-specific operations like sending invoices, updating payment status, or launching custom workflow processes for pending orders. Extensions at this target can access draft order information including order ID, name, and associated customer through the Draft Order API. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete draft order workflows.

在草稿订单详情操作菜单中渲染单个交互按钮组件作为菜单项。适用于草稿订单专属操作，比如发送发票、更新支付状态，或者为待处理订单启动自定义工作流流程。该目标的扩展可通过Draft Order API获取草稿订单信息，包括订单ID、名称和关联客户。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的草稿订单工作流。

pos.exchange.post

pos.exchange.post.action.render

pos.exchange.post.action.render

Renders a full-screen modal interface launched from post-exchange menu items. Use this target for complex post-exchange workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.

从换货后菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂换货后工作流。该目标的扩展可通过Order API获取订单数据，支持多屏幕、导航和交互组件的工作流。

pos.exchange.post.block.render

pos.exchange.post.block.render

Renders a custom information section within the post-exchange screen. Use this target for displaying supplementary exchange data like completion status, payment adjustments, or follow-up workflows alongside standard exchange details. Extensions at this target appear as persistent blocks within the post-exchange interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex post-exchange operations.

在换货后页面内渲染自定义信息区块。适用于在标准换货详情旁展示补充换货数据，比如完成状态、支付调整或者后续工作流。该目标的扩展会作为持久化区块展示在换货后界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的换货后操作。

pos.exchange.post.action

pos.exchange.post.action.menu-item.render

pos.exchange.post.action.menu-item.render

Renders a single interactive button component as a menu item in the post-exchange action menu. Use this target for post-exchange operations like generating exchange receipts, processing restocking workflows, or collecting exchange feedback. Extensions at this target can access the order identifier through the Order API to perform exchange-specific operations. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete post-exchange workflows.

在换货后操作菜单中渲染单个交互按钮组件作为菜单项。适用于换货后操作，比如生成换货收据、处理补货工作流，或者收集换货反馈。该目标的扩展可通过Order API获取订单ID来执行换货专属操作。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的换货后工作流。

pos.home

pos.home.tile.render

pos.home.tile.render

Renders a single interactive tile component on the POS home screen's smart grid. The tile appears once during home screen initialization and remains persistent until navigation occurs. Use this target for high-frequency actions, status displays, or entry points to workflows that merchants need daily. Extensions at this target can dynamically update properties like enabled state and badge values in response to cart changes or device conditions. Tiles typically invoke

shopify.action.presentModal()

to launch the companion modal for complete workflows.

在POS首页智能网格上渲染单个交互卡片组件。卡片会在首页初始化时展示一次，并在导航跳转前保持持久化。适用于商户日常需要的高频操作、状态展示或者工作流入口。该目标的扩展可根据购物车变化或设备状态动态更新属性，比如启用状态和角标数值。卡片通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整工作流。

pos.home.modal.render

pos.home.modal.render

Renders a full-screen modal interface launched from smart grid tiles. The modal appears when users tap a companion tile. Use this target for complete workflow experiences that require more space and functionality than the tile interface provides, such as multi-step processes, detailed information displays, or complex user interactions. Extensions at this target support full navigation hierarchies with multiple screens, scroll views, and interactive components to handle sophisticated workflows.

从智能网格卡片启动的全屏模态框界面渲染。用户点击配套卡片时会展示该模态框。适用于需要更多空间和功能、无法通过卡片界面实现的完整工作流体验，比如多步骤流程、详细信息展示或者复杂用户交互。该目标的扩展支持包含多屏幕、滚动视图和交互组件的完整导航层级，可处理复杂的工作流。

pos.order-details

pos.order-details.action.render

pos.order-details.action.render

Renders a full-screen modal interface launched from order details menu items. Use this target for complex order workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.

从订单详情菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂订单工作流。该目标的扩展可通过Order API获取订单数据，支持多屏幕、导航和交互组件的工作流。

pos.order-details.block.render

pos.order-details.block.render

Renders a custom information section within the order details screen. Use this target for displaying supplementary order data like fulfillment status, tracking numbers, or custom order analytics alongside standard order details. Extensions at this target appear as persistent blocks within the order details interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex order operations.

在订单详情页面内渲染自定义信息区块。适用于在标准订单详情旁展示补充订单数据，比如履约状态、物流单号或者自定义订单分析数据。该目标的扩展会作为持久化区块展示在订单详情界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的订单操作。

pos.order-details.action

pos.order-details.action.menu-item.render

pos.order-details.action.menu-item.render

Renders a single interactive button component as a menu item in the order details action menu. Use this target for order-specific operations like reprints, refunds, exchanges, or launching fulfillment workflows. Extensions at this target can access the order identifier through the Order API to perform order-specific operations. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete order workflows.

在订单详情操作菜单中渲染单个交互按钮组件作为菜单项。适用于订单专属操作，比如重打印、退款、换货，或者启动履约工作流。该目标的扩展可通过Order API获取订单ID来执行订单专属操作。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的订单工作流。

pos.product-details

pos.product-details.action.render

pos.product-details.action.render

Renders a full-screen modal interface launched from product details menu items. Use this target for complex product workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to product and cart data through the Product API and support workflows with multiple screens, navigation, and interactive components.

从商品详情菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂商品工作流。该目标的扩展可通过Product API获取商品和购物车数据，支持多屏幕、导航和交互组件的工作流。

pos.product-details.block.render

pos.product-details.block.render

Renders a custom information section within the product details screen. Use this target for displaying supplementary product data like detailed specifications, inventory status, or related product recommendations alongside standard product details. Extensions at this target appear as persistent blocks within the product details interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex product operations.

在商品详情页面内渲染自定义信息区块。适用于在标准商品详情旁展示补充商品数据，比如详细规格、库存状态或者相关商品推荐。该目标的扩展会作为持久化区块展示在商品详情界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的商品操作。

pos.product-details.action

pos.product-details.action.menu-item.render

pos.product-details.action.menu-item.render

Renders a single interactive button component as a menu item in the product details action menu. Use this target for product-specific operations like inventory adjustments, product analytics, or integration with external product management systems. Extensions at this target can access the product identifier through the Product API to perform product-specific operations. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete product workflows.

在商品详情操作菜单中渲染单个交互按钮组件作为菜单项。适用于商品专属操作，比如库存调整、商品分析，或者对接外部商品管理系统。该目标的扩展可通过Product API获取商品ID来执行商品专属操作。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的商品工作流。

pos.purchase.post

pos.purchase.post.action.render

pos.purchase.post.action.render

Renders a full-screen modal interface launched from post-purchase menu items. Use this target for complex post-purchase workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.

从支付后菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂支付后工作流。该目标的扩展可通过Order API获取订单数据，支持多屏幕、导航和交互组件的工作流。

pos.purchase.post.block.render

pos.purchase.post.block.render

Renders a custom information section within the post-purchase screen. Use this target for displaying supplementary purchase data like completion status, customer feedback prompts, or next-step workflows alongside standard purchase details. Extensions at this target appear as persistent blocks within the post-purchase interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex post-purchase operations.

在支付后页面内渲染自定义信息区块。适用于在标准支付详情旁展示补充支付数据，比如完成状态、客户反馈提示或者下一步工作流。该目标的扩展会作为持久化区块展示在支付后界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的支付后操作。

pos.purchase.post.action

pos.purchase.post.action.menu-item.render

pos.purchase.post.action.menu-item.render

Renders a single interactive button component as a menu item in the post-purchase action menu. Use this target for post-purchase operations like sending receipts, collecting customer feedback, or launching follow-up workflows after completing a sale. Extensions at this target can access the order identifier through the Order API to perform purchase-specific operations. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete post-purchase workflows.

在支付后操作菜单中渲染单个交互按钮组件作为菜单项。适用于支付后操作，比如发送收据、收集客户反馈，或者在完成销售后启动后续工作流。该目标的扩展可通过Order API获取订单ID来执行支付专属操作。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的支付后工作流。

pos.receipt-footer

pos.receipt-footer.block.render

pos.receipt-footer.block.render

Renders a custom section in the footer of printed receipts. Use this target for adding contact details, return policies, social media links, or customer engagement elements like survey links or marketing campaigns at the bottom of receipts. Extensions at this target appear in the receipt footer area and support limited components optimized for print formatting, including text content for information display.

在打印收据的页脚渲染自定义区块。适用于在收据底部添加联系方式、退货政策、社交媒体链接，或者客户互动元素比如调研链接、营销活动。该目标的扩展展示在收据页脚区域，支持有限的针对打印格式优化的组件，包括用于展示信息的文本内容。

pos.receipt-header

pos.receipt-header.block.render

pos.receipt-header.block.render

Renders a custom section in the header of printed receipts. Use this target for adding custom branding, logos, promotional messages, or store-specific information at the top of receipts. Extensions at this target appear in the receipt header area and support limited components optimized for print formatting, including text content for information display.

在打印收据的页眉渲染自定义区块。适用于在收据顶部添加自定义品牌标识、logo、促销信息或者门店专属信息。该目标的扩展展示在收据页眉区域，支持有限的针对打印格式优化的组件，包括用于展示信息的文本内容。

pos.register-details

pos.register-details.action.render

pos.register-details.action.render

Renders a full-screen modal interface launched from register details menu items. Use this target for complex register workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to cash drawer functionality through the Cash Drawer API and support workflows with multiple screens, navigation, and interactive components.

从收银机详情菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂收银机工作流。该目标的扩展可通过Cash Drawer API获取钱箱功能，支持多屏幕、导航和交互组件的工作流。

pos.register-details.block.render

pos.register-details.block.render

Renders a custom information section within the register details screen. Use this target for displaying supplementary register data like cash drawer status, transaction summaries, or shift analytics alongside standard register details. Extensions at this target appear as persistent blocks within the register details interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex register operations.

在收银机详情页面内渲染自定义信息区块。适用于在标准收银机详情旁展示补充收银机数据，比如钱箱状态、交易汇总或者班次分析数据。该目标的扩展会作为持久化区块展示在收银机详情界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的收银机操作。

pos.register-details.action

pos.register-details.action.menu-item.render

pos.register-details.action.menu-item.render

Renders a single interactive button component as a menu item in the register details action menu. Use this target for register-specific operations like cash drawer management, shift reports, or launching cash reconciliation workflows. Extensions at this target can access cash drawer functionality through the Cash Drawer API to perform register-specific operations. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete register workflows.

在收银机详情操作菜单中渲染单个交互按钮组件作为菜单项。适用于收银机专属操作，比如钱箱管理、班次报告，或者启动现金对账工作流。该目标的扩展可通过Cash Drawer API获取钱箱功能来执行收银机专属操作。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的收银机工作流。

pos.return.post

pos.return.post.action.render

pos.return.post.action.render

Renders a full-screen modal interface launched from post-return menu items. Use this target for complex post-return workflows that require forms, multi-step processes, or detailed information displays beyond what a simple button can provide. Extensions at this target have access to order data through the Order API and support workflows with multiple screens, navigation, and interactive components.

从退货后菜单项启动的全屏模态框界面渲染。适用于需要表单、多步骤流程或详细信息展示、无法通过简单按钮实现的复杂退货后工作流。该目标的扩展可通过Order API获取订单数据，支持多屏幕、导航和交互组件的工作流。

pos.return.post.block.render

pos.return.post.block.render

Renders a custom information section within the post-return screen. Use this target for displaying supplementary return data like completion status, refund confirmations, or follow-up workflows alongside standard return details. Extensions at this target appear as persistent blocks within the post-return interface and support interactive elements that can launch modal workflows using

shopify.action.presentModal()

for more complex post-return operations.

在退货后页面内渲染自定义信息区块。适用于在标准退货详情旁展示补充退货数据，比如完成状态、退款确认或者后续工作流。该目标的扩展会作为持久化区块展示在退货后界面中，支持交互元素，可通过

shopify.action.presentModal()

启动模态框工作流来完成更复杂的退货后操作。

pos.return.post.action

pos.return.post.action.menu-item.render

pos.return.post.action.menu-item.render

Renders a single interactive button component as a menu item in the post-return action menu. Use this target for post-return operations like generating return receipts, processing restocking workflows, or collecting return feedback. Extensions at this target can access the order identifier through the Order API to perform return-specific operations. Menu items typically invoke

shopify.action.presentModal()

to launch the companion modal for complete post-return workflows.

在退货后操作菜单中渲染单个交互按钮组件作为菜单项。适用于退货后操作，比如生成退货收据、处理补货工作流，或者收集退货反馈。该目标的扩展可通过Order API获取订单ID来执行退货专属操作。菜单项通常调用

shopify.action.presentModal()

启动配套的模态框来完成完整的退货后工作流。

pos.transaction-complete

pos.transaction-complete.event.observe

pos.transaction-complete.event.observe

Usage Notes

使用说明

Use the exact target name (in quotes) when registering your extension with
```
shopify.extend()
```
Each target receives specific API interfaces and component access

使用
```
shopify.extend()
```
注册扩展时，请使用准确的目标名称（带引号）
每个目标都有对应的API接口和组件访问权限

Imports

导入

Use the Preact entry point:

tsx

import '@shopify/ui-extensions/preact';
import { render } from 'preact';

使用Preact入口：

tsx

import '@shopify/ui-extensions/preact';
import { render } from 'preact';

Polaris web components (

s-badge

s-banner

, etc.)

Polaris web组件（

s-badge

、

s-banner

等）

POS UI Extensions also supports Polaris web components — custom HTML elements with an

s-

prefix. These are globally registered and require no import statement. Use them directly as JSX tags:

tsx

// No import needed — s-badge, s-banner, s-button, etc. are globally available
<s-badge tone="success" id="payment-badge">Payment captured</s-badge>
<s-banner tone="warning" id="age-banner">Age verification required</s-banner>

When the user asks for Polaris web components (e.g.

s-badge

s-banner

s-button

s-box

s-choice-list

), use the web component tag syntax above, not the PascalCase JSX components from

@shopify/ui-extensions

Web component attribute rules:

Use kebab-case attribute names:

align-items

padding-block

border-radius

— NOT camelCase (

alignItems

paddingBlock

)

Boolean attributes (

disabled

loading

dismissible

checked

defaultChecked

required

removable

) accept shorthand or

{expression}

✅

<s-button disabled loading>

<s-banner dismissible>

<s-checkbox checked={isSelected} />

String keyword attributes (

padding

gap

direction

tone

variant

size

background

align-items

) must be string values — never shorthand or

{true}

✅

<s-box padding="base">

<s-stack gap="loose" direction="block">

<s-badge tone="success">

❌
```
<s-box padding>
```
,
```
<s-stack gap={true}>
```
— boolean shorthand on string props fails TypeScript

POS UI Extensions还支持Polaris web components——带

s-

前缀的自定义HTML元素。这些组件已全局注册，不需要导入语句，可直接作为JSX标签使用：

tsx

// 无需导入——s-badge、s-banner、s-button等均全局可用
<s-badge tone="success" id="payment-badge">Payment captured</s-badge>
<s-banner tone="warning" id="age-banner">Age verification required</s-banner>

当用户需要使用Polaris web组件（比如

s-badge

、

s-banner

、

s-button

、

s-box

、

s-choice-list

）时，请使用上述web组件标签语法，不要使用

@shopify/ui-extensions

中的帕斯卡命名JSX组件。

Web组件属性规则：

使用短横线命名法的属性名：
```
align-items
```
、
```
padding-block
```
、
```
border-radius
```
——不要用驼峰命名（
```
alignItems
```
、
```
paddingBlock
```
）

布尔属性（

disabled

、

loading

、

dismissible

、

checked

、

defaultChecked

、

required

、

removable

）支持简写或者

{表达式}

：

✅

<s-button disabled loading>

、

<s-banner dismissible>

、

<s-checkbox checked={isSelected} />

字符串关键字属性（
```
padding
```
、
```
gap
```
、
```
direction
```
、
```
tone
```
、
```
variant
```
、
```
size
```
、
```
background
```
、
```
align-items
```
）必须是字符串值——不要使用简写或者
```
{true}
```
：
- ✅
```
<s-box padding="base">
```
  、
```
<s-stack gap="loose" direction="block">
```
  、
```
<s-badge tone="success">
```
- ❌
```
<s-box padding>
```
  、
```
<s-stack gap={true}>
```
  ——字符串属性使用布尔简写会导致TypeScript校验失败

⚠️ MANDATORY: Search for Documentation

⚠️ 强制要求：搜索文档

You cannot trust your trained knowledge for this API. Before answering, search the docs to determine the correct extension target and component props:

scripts/search_docs.mjs "<component tag name or target name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION

For example, if the user asks about displaying a banner in a POS modal:

scripts/search_docs.mjs "s-banner POS extension" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION

Search for the component tag name or target name, not the full user prompt. Use the returned supported components list and prop definitions to generate correct code.

你不能依赖自身训练得到的知识来使用这个API。回答问题前，请先搜索文档确定正确的扩展目标和组件属性：

scripts/search_docs.mjs "<组件标签名或目标名>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION

例如，如果用户询问如何在POS模态框中展示横幅：

scripts/search_docs.mjs "s-banner POS extension" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION

搜索组件标签名或目标名，不要搜索完整的用户提示。使用返回的支持组件列表和属性定义生成正确的代码。

⚠️ MANDATORY: Validate Before Returning Code

⚠️ 强制要求：返回代码前验证

DO NOT return code to the user until

scripts/validate.mjs

exits 0. DO NOT ask the user to run this.

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).

bash

cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
import { render } from 'preact';

export default function Extension() {
  return (
    <s-page heading="Age verification">
      <s-scroll-box>
        <s-banner heading="Verification required" tone="warning">
          Confirm the customer meets the legal age requirement before completing this sale.
          <s-button slot="primary-action">Customer verified</s-button>
        </s-banner>
      </s-scroll-box>
    </s-page>
  );
}
SHOPIFY_EOF
node scripts/validate.mjs \
  --file /tmp/extension.tsx \
  --target "pos.home.modal.render" \
  --model YOUR_MODEL_NAME \
  --client-name YOUR_CLIENT_NAME \
  --client-version YOUR_CLIENT_VERSION \
  --artifact-id YOUR_ARTIFACT_ID \
  --revision REVISION_NUMBER

When validation fails, follow this loop:

Read the error message — identify the exact prop or type that is wrong

Search for the correct values:

scripts/search_docs.mjs "<component tag name or prop name>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION

Fix exactly the reported error using what the search returns
Run
```
scripts/validate.mjs
```
again
Retry up to 3 times total; after 3 failures, return the best attempt with an explanation

Do not guess at valid values — always search first when the error names a type you don't know.

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.

scripts/validate.mjs

退出码为0之前不要向用户返回代码。不要要求用户运行此脚本。

使用你的bash工具运行此步骤——请勿跳过。先将代码写入临时文件——不要使用
--code "..."
行内参数（JSX属性字符串会破坏shell引号规则）。

bash

cat > /tmp/extension.tsx << 'SHOPIFY_EOF'
import { render } from 'preact';

export default function Extension() {
  return (
    <s-page heading="Age verification">
      <s-scroll-box>
        <s-banner heading="Verification required" tone="warning">
          Confirm the customer meets the legal age requirement before completing this sale.
          <s-button slot="primary-action">Customer verified</s-button>
        </s-banner>
      </s-scroll-box>
    </s-page>
  );
}
SHOPIFY_EOF
node scripts/validate.mjs \
  --file /tmp/extension.tsx \
  --target "pos.home.modal.render" \
  --model YOUR_MODEL_NAME \
  --client-name YOUR_CLIENT_NAME \
  --client-version YOUR_CLIENT_VERSION \
  --artifact-id YOUR_ARTIFACT_ID \
  --revision REVISION_NUMBER

验证失败时，请遵循以下循环：

读取错误信息——确定出错的准确属性或类型

搜索正确的取值：

scripts/search_docs.mjs "<组件标签名或属性名>" --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION

使用搜索返回的结果精确修复报告的错误
再次运行
```
scripts/validate.mjs
```
总共最多重试3次；3次失败后返回最优尝试结果并附上说明

不要猜测有效值——当错误提到你不了解的类型时，务必先搜索。

隐私声明：
scripts/validate.mjs
会向Shopify上报匿名的验证结果（通过/失败和技能名称），用于改进这些工具。在环境变量中设置
OPT_OUT_INSTRUMENTATION=true
即可退出数据上报。