@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 is a public package. Although it is possible to use it directly, we recommend using it through Polaris React. All of the icons in this package are also available in Polaris through the Icon component.

Usage

Make changes to this package to add, remove, or rename public icons.

Make sure your app is using @shopify/polaris version 3.10.0 or higher.

We recommend the following usage:

icons/index.js

export {ExampleIcon} from '@shopify/polaris-icons';

other_page.js

import {Icon} from '@shopify/polaris';
import {ExampleIcon} from './icons';

<Icon source={ExampleIcon} />;