Package Exports

@shopify/polaris-icons

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@shopify/polaris-icons) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@shopify/polaris-icons

This package exports a JavaScript file containing the Polaris icons that can be used by partners building on the Shopify platform, and contains SVG files in the /images/ directory.

Browse and search Polaris icons: https://polaris-icons.shopify.com.

Getting started

Although it's possible to use this package directly, we recommend using the icons in this package through Polaris React in combination with the Icon component from that project. Make sure that your app is using Polaris React version 3.10.0 or higher.

Installation

After you have Polaris React installed, you need to add Polaris icons as a dependency.

Run the following command using npm:

npm install @shopify/polaris-icons --save

If you prefer Yarn, then use the following command instead:

yarn add @shopify/polaris-icons

Usage

Import the Icon component from Polaris React and any icon from Polaris icons into your project.

Include the icon component from Polaris React:
```
import {Icon} from '@shopify/polaris';
```

Include an icon from Polaris icons:

import {AddMajorMonotone} from '@shopify/polaris-icons';

Pass the imported Polaris icon to the source prop of the Icon component:
```
<Icon source={AddMajorMonotone} />
```

SVG files

For consumers who don’t use React, we provide SVG files within the images folder.

View the list of available files on unpkg.

Contributing 🙌

Make changes to this package to add, remove, or rename publicly available icons. See our contributing guide. 👀

Licenses 📝

Source code is under a custom license based on MIT. The license restricts Polaris icons 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.