@shopify/polaris-icons

What is @shopify/polaris-icons?

@shopify/polaris-icons is a package that provides a collection of icons used in Shopify's Polaris design system. These icons are designed to be used in Shopify applications to maintain a consistent look and feel.

What are @shopify/polaris-icons's main functionalities?

Importing Icons

You can import individual icons from the @shopify/polaris-icons package. This allows you to use specific icons in your application without importing the entire icon set.

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

Using Icons in Components

You can use the imported icons in your components by passing them as a source to the Icon component from the Polaris library.

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

function MyComponent() {
  return (
    <Icon source={CirclePlusMajor} />
  );
}

Customizing Icon Size and Color

You can customize the size and color of the icons by passing additional props to the Icon component.

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

function MyComponent() {
  return (
    <Icon source={CirclePlusMajor} color="red" backdrop />
  );
}

Other packages similar to @shopify/polaris-icons

react-icons

react-icons is a popular library that provides a wide range of icons from various icon libraries such as Font Awesome, Material Design, and more. It offers a more extensive collection of icons compared to @shopify/polaris-icons and is highly customizable.

fontawesome

fontawesome is a widely-used icon library that offers a vast collection of icons. It provides both free and premium icons and is highly customizable. Font Awesome icons can be used in various frameworks and libraries, making it a versatile choice.

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.

1. Include the icon component from Polaris React:

   import {Icon} from '@shopify/polaris';
   

2. Include an icon from Polaris icons:

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

3. 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.