gem-hunter
Language: TypeScript
Shopify's Polaris Design System - React implementation (Deprecated)
This repository is archived and unmaintained.
- Archived documentation: https://shopify.github.io/polaris-react-archive/
- For current Shopify admin development, use Polaris on shopify.dev: https://shopify.dev/docs/api/polaris
The Shopify Polaris React library is deprecated.
We are no longer accepting contributions or feature requests in this repository.
On October 1, 2025, we released our Polaris Web Components for Shopify app development. We encourage Shopify App developers to adopt Polaris Web Components for new development.
This repository will remain available for historical purposes, but it will not receive updates or maintenance.
Polaris Web Components provide a more technology-agnostic foundation.
They work with every framework as well as plain JavaScript and server-rendered sites, enabling more Shopify App developers across more platforms to use Polaris.
The shopify/polaris repository is an intergalactic monorepo made up of NPM packages, VSCode extensions, and websites.
polaris/ ├── documentation # Documentation for working in the monorepo ├── polaris-for-vscode # VS Code extension for Polaris ├── polaris-icons # Icons for Polaris ├── polaris-react # Components for @shopify/polaris package ├── polaris-tokens # Design tokens for Polaris ├── polaris.shopify.com # Documentation website └── stylelint-polaris # Rules for custom property usage and mainline coverage
pnpm install && pnpm buildOne workspace
Run commands from a selected workspace using turbo run <command> --filter=<workspace>... flag.
| Command | Runs |
|---|---|
pnpm turbo run dev --filter=@shopify/polaris |
Open the react component storybook |
pnpm turbo run dev --filter=polaris.shopify.com |
Open polaris.shopify.com NextJS site |
All workspaces
Run commands across all workspaces. This uses turbo run <command>.
| Command | Runs |
|---|---|
pnpm changeset |
Adds a new changelog entry |
pnpm lint |
Lints all workspaces |
pnpm test |
Tests all workspaces |
pnpm type-check |
Build types and check for type errors |
pnpm clean |
Remove generated files |
pnpm format |
Format files with prettier |
Pull requests are welcome. See the contribution guidelines for more information.
Source code is under a custom license based on MIT. The license restricts Polaris usage to applications that integrate or interoperate with Shopify software or services, with additional restrictions for external, stand-alone applications.
All icons and images are licensed under the Polaris Design Guidelines License Agreement