shopify-polaris-admin-extensions

Add contextual actions and blocks to Shopify Admin via Polaris Admin Extensions.

Updated Nov 16, 2022
One-click install
npx skills add https://github.com/kos3nz/dotfiles --skill shopify-polaris-admin-extensions-kos3nz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shopify-polaris-admin-extensions
Source: https://github.com/kos3nz/dotfiles/tree/main/.config/agents/skills/shopify-polaris-admin-extensions
Command: npx skills add https://github.com/kos3nz/dotfiles --skill shopify-polaris-admin-extensions-kos3nz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Extend Shopify Admin by adding contextual actions and blocks from your app, streamlining merchant workflows.

Core Features & Use Cases

  • Contextual actions on resource pages and lists to trigger app workflows.
  • Inline blocks that display app data and actions within the Admin UI.
  • Scaffolding of new admin extensions via Shopify CLI commands to accelerate integration.

Quick Start

Scaffold a new admin action extension using the Shopify CLI and wire it into the Admin UI.

Frequently Asked Questions about shopify-polaris-admin-extensions

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

FAQPage Schema
How do I add contextual actions to the Shopify Admin?

You add contextual actions to the Shopify Admin by using Polaris Admin Extensions to integrate app workflows into resource pages, action menus, and modals, streamlining merchant workflows directly within the UI.

What are Polaris Admin Extensions used for?

Polaris Admin Extensions are used to augment merchant workflows by adding inline blocks and contextual actions within the Shopify Admin UI, allowing apps to display data and trigger workflows natively.

How do I scaffold a new admin extension with Shopify CLI?

You scaffold a new admin extension by running Shopify CLI commands, which guide the creation of YAML-based metadata, a SKILL.md file, and optional resource directories to wire the extension into the Admin UI.

Can I display app data inside Shopify Admin resource pages?

Yes, you can display app data inside Shopify Admin resource pages by building inline blocks with Polaris Admin Extensions, presenting app information and actions within the native merchant interface.

Do I need YAML metadata to build Shopify admin actions?

Yes, you need YAML-based metadata and a valid SKILL.md file containing a name and description to satisfy the frontmatter requirements when scaffolding Shopify admin actions via the CLI.