Shopify’s design system to help us work together to build a great experience for all of our merchants.
Installations
npm install @shopify/polaris-tokensReleases
822
@shopify/polaris@13.9.1
@shopify/polaris@13.9.1
Published on 31 Oct 2024
@shopify/polaris@13.9.0
@shopify/polaris@13.9.0
Published on 01 Aug 2024
@shopify/polaris@13.8.1
@shopify/polaris@13.8.1
Published on 30 Jul 2024
@shopify/stylelint-polaris@16.0.5
@shopify/stylelint-polaris@16.0.5
Published on 30 Jul 2024
@shopify/polaris-tokens@9.4.0
@shopify/polaris-tokens@9.4.0
Published on 30 Jul 2024
@shopify/polaris-migrator@1.0.5
@shopify/polaris-migrator@1.0.5
Published on 30 Jul 2024
Contributors
7,158
![shopify-github-actions-access[bot]](https://avatars.githubusercontent.com/in/221189?v=4){kind=avatar}
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4){kind=avatar}
Developer
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
>=20.10.0
Typescript Support
Yes
Node Version
20.11.1
NPM Version
10.2.4
Statistics
5,822 Stars
10,482 Commits
1,174 Forks
509 Watching
860 Branches
7,158 Contributors
Updated on 26 Nov 2024
Bundle Size
138.19 kB
Minified
13.62 kB
Minified + Gzipped
Languages
TypeScript (63.49%)
MDX (14.91%)
HTML (11.58%)
CSS (4.76%)
SCSS (2.99%)
JavaScript (2.24%)
Handlebars (0.03%)
Total Downloads
Cumulative downloads
Total Downloads
26,740,750
Last day
-11.1%
15,169
Compared to previous day
Last week
-6.1%
86,480
Compared to previous week
Last month
-4.4%
399,482
Compared to previous month
Last year
-14.3%
5,978,577
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Versions
Polaris
Build. Contribute. Evolve. Shape the merchant experience for Shopify’s core product, the admin.
| Status | Owner | Help |
|---|---|---|
| Active | @shopify/polaris | New issue |
About this repo
The shopify/polaris repository is an intergalactic monorepo made up of NPM packages, VSCode extensions, and websites.
1polaris/ 2├── documentation # Documentation for working in the monorepo 3├── polaris-for-vscode # VS Code extension for Polaris 4├── polaris-icons # Icons for Polaris 5├── polaris-react # Components for @shopify/polaris package 6├── polaris-tokens # Design tokens for Polaris 7├── polaris.shopify.com # Documentation website 8└── stylelint-polaris # Rules for custom property usage and mainline coverage
Commands
Install dependencies and build workspaces
1pnpm install && pnpm build
Run a command
One 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 |
Contribute to this repo
Pull requests are welcome. See the contribution guidelines for more information.
Licenses
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
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
Found 22/24 approved changesets -- score normalized to 9
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/Shopify/.github/SECURITY.md:1
- Info: Found linked content: github.com/Shopify/.github/SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: github.com/Shopify/.github/SECURITY.md:1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/changelog.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-a11y-vrt.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-test.yml:1
- Warn: no topLevel permission defined: .github/workflows/cla.yml:1
- Warn: no topLevel permission defined: .github/workflows/deploy-polaris.shopify.com.yml:1
- Warn: no topLevel permission defined: .github/workflows/major-version-check.yml:1
- Warn: no topLevel permission defined: .github/workflows/migrator-comment.yml:1
- Warn: no topLevel permission defined: .github/workflows/non-committable.yml:1
- Warn: no topLevel permission defined: .github/workflows/release-vscode.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/snapit.yml:1
- Warn: no topLevel permission defined: .github/workflows/stale.yml:1
- Warn: no topLevel permission defined: .github/workflows/untriaged-labeler.yml:1
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/changelog.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/changelog.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/changelog.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/changelog.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/changelog.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/changelog.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:129: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:132: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:138: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-a11y-vrt.yml:162: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-a11y-vrt.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-lint.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-lint.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-lint.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-lint.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-test.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-test.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-test.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-test.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/ci-test.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/cla.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/cla.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-polaris.shopify.com.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/deploy-polaris.shopify.com.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/major-version-check.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/major-version-check.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/migrator-comment.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/migrator-comment.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/non-committable.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/non-committable.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/non-committable.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/non-committable.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-vscode.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/release-vscode.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-vscode.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/release-vscode.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-vscode.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/release-vscode.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snapit.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/snapit.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/snapit.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/snapit.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/snapit.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/snapit.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/stale.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/untriaged-labeler.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/untriaged-labeler.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/untriaged-labeler.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/Shopify/polaris/untriaged-labeler.yml/main?enable=pin
- Info: 0 out of 26 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 14 third-party GitHubAction dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
30 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
- Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-54xq-cgqr-rpm3
- Warn: Project is vulnerable to: GHSA-325j-24f4-qv5x
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
- Warn: Project is vulnerable to: GHSA-m95q-7qp3-xv42
Score
5.3
/10
Last Scanned on 2024-07-01
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to @shopify/polaris-tokens
@shopify/polaris-icons
9.3.0
[](https://www.npmjs.com/package/@shopify/polaris-icons)
@shopify/polaris
13.9.1
Shopify’s admin product component library
@shopify/polaris-viz-core
15.3.2
Core logic for Polaris Viz that is not platform specific
@shopify/polaris-viz
15.3.2
Shopify’s viz component library