Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 10,674 Commits
.changeset		.changeset
.github		.github
.vscode		.vscode
documentation		documentation
polaris-for-vscode		polaris-for-vscode
polaris-icons		polaris-icons
polaris-migrator		polaris-migrator
polaris-react		polaris-react
polaris-tokens		polaris-tokens
polaris.shopify.com		polaris.shopify.com
stylelint-polaris		stylelint-polaris
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierignore		.prettierignore
.prettierrc		.prettierrc
.stylelintrc.js		.stylelintrc.js
LICENSE.md		LICENSE.md
README.md		README.md
babel.config.js		babel.config.js
dev.yml		dev.yml
jest.config.js		jest.config.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
translation.yml		translation.yml
tsconfig.eslint.json		tsconfig.eslint.json
tsconfig.json		tsconfig.json
turbo.json		turbo.json

Repository files navigation

Polaris React (⚠️ Deprecated)

TheShopify Polaris React library is deprecated.
We are no longer accepting contributions or feature requests in this repository.

On October 1, 2025, we released ourPolaris 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.

Why Web Components?

Polaris Web Components provide a moretechnology-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.

About this repo

Theshopify/polaris repository is anintergalactic 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

Commands

Install dependencies and build workspaces

pnpm install&& pnpm build

Run a command

One workspace

Run commands from a selected workspace usingturbo 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 usesturbo run <command>.

Command	Runs
`pnpm changeset`	Adds a newchangelog 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

Contribute to this repo

Pull requests are welcome. See thecontribution guidelines for more information.

Licenses

Source code is under acustom 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 thePolaris Design Guidelines License Agreement