[![npm version](https://img.shields.io/npm/v/@shopify/polaris-icons.svg?style=flat)](https://www.npmjs.com/package/@shopify/polaris-icons)
The npm package @shopify/polaris-icons offers a comprehensive library of icons specifically designed to enhance the visual and user interface elements of web applications, particularly those built on the Shopify platform. This collection is meticulously curated to ensure coherence and versatility across a wide range of digital environments. Each icon in the library adheres to Shopify’s Polaris design system, which aims to create a consistent and accessible experience for all users. The icons are optimized for performance and are ready to be used in both web and mobile applications, making them an essential resource for developers looking to improve their Shopify store’s aesthetics and user engagement.
To start using these icons in your project, the process is straightforward with the command 'npm install @shopify/polaris-icons'. This command installs the icon library into your project, allowing you to easily incorporate any of the available icons into your application. The icons are SVG format, ensuring they are scalable and maintain high quality at any size, which is perfect for responsive design. By integrating these icons, developers can maintain a high level of design consistency across their applications, aligning closely with the best practices of Shopify’s own user interface guidelines.
The @shopify/polaris-icons package not only enhances the visual appeal of applications but also plays a crucial role in improving the overall user experience. Icons can communicate actions and content clearly and succinctly, making navigation more intuitive and interactions more efficient. This can lead to better engagement rates and a smoother user journey, which are critical factors for success in e-commerce. Additionally, since the icons are part of the Polaris design system, they help maintain a seamless visual language across all parts of the application, contributing to a stronger brand identity and a more professional appearance.
[![npm version](https://img.shields.io/npm/v/@shopify/polaris-icons.svg?style=flat)](https://www...
Read moreA set of utilities, interfaces, and models that are common across all the platform...
Read moreThe JavaScript Drag & Drop library your grandparents warned you about...
Read more**[Join our team and work on libraries like this one.](https://www.shopify...
Read moreShopify GraphQL Client - A lightweight generic GraphQL JS client to interact with Shopify GraphQL...
Read moreShopify Storefront API Client - A lightweight JS client to interact with Shopify's Storefront...
Read moreThis is the Node.js wrapper of the runtime-agnostic [`@shopify/theme-check-common`](https://npm...
Read moreCore dependencies of this npm package and its dev dependencies.
@babel/core, @babel/node, @babel/preset-env, @babel/preset-react, @babel/preset-typescript, @changesets/changelog-github, @changesets/cli, @changesets/get-release-plan, @next/eslint-plugin-next, @rollup/plugin-babel, @rollup/plugin-commonjs, @rollup/plugin-image, @rollup/plugin-json, @rollup/plugin-node-resolve, @rollup/plugin-replace, @rollup/plugin-virtual, @rollup/pluginutils, @shopify/eslint-plugin, @shopify/stylelint-plugin, @shopify/typescript-configs, @size-limit/preset-small-lib, @types/jest, @types/node, babel-loader, eslint, eslint-plugin-storybook, execa, jest, jest-environment-jsdom, jest-preset-stylelint, jest-watch-typeahead, js-yaml, npm-run-all, postinstall-postinstall, prettier, rollup, rollup-plugin-node-externals, size-limit, stylelint, ts-node, turbo, typescript
A README file for the @shopify/polaris-icons code repository. View Code
Build. Contribute. Evolve. Shape the merchant experience for Shopify’s core product, the admin.
Status | Owner | Help |
---|---|---|
Active | @shopify/polaris | New issue |
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 build
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 |
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