npm package: @justeattakeaway/pie-icons-react
Description: PIE Design System Icon set for React
Latest version: 5.20.1

# pie-icons-react

> [!WARNING]
> **Deprecated:** This package is deprecated and will no longer receive updates.
> Please migrate to [`@justeattakeaway/pie-icons-webc`](https://github.com/justeattakeaway/pie/tree/main/packages/tools/pie-icons-webc), which provides framework-agnostic web components compatible with React, Vue, and vanilla JS.
> See the [`pie-icons-webc` README](https://github.com/justeattakeaway/pie/tree/main/packages/tools/pie-icons-webc#react) for React usage instructions.

Shared PIE Icon Components for ReactJS.

This package generates an iconset for React applications using the base [pie-icons](https://www.npmjs.com/package/@justeattakeaway/pie-icons) package. The SVGs in pie-icons are compiled into React components.

The icons are bundled in CommonJS and ES Modules, to be more easily adopted for modern React Applications.

---

[![npm version](https://img.shields.io/npm/v/@justeattakeaway/pie-icons-react.svg)](https://img.shields.io/npm/v/@justeattakeaway/pie-icons-react.svg)

---

## Usage

### Installation

Add the module to your project

```bash
yarn add @justeattakeaway/pie-icons-react
```

### React Applications

```tsx
import { IconAlertTriangleLarge, IconCalendar } from "@justeattakeaway/pie-icons-react";

export default function App() {
  return (
    <div className="App">
      <IconCalendar />
      <IconAlertTriangleLarge fill={PIE_ALIAS_COLOR_TOKEN} />
    </div>
  );
}
```

You can also import icons individually from the dist folder. Consider doing this if you are having issues with tree-shaking or the size of the icons in your bundle.

```js
import IconAlertTriangleLarge from '@justeattakeaway/pie-icons-react/dist/IconAlertTriangleLarge';
import IconCalendar from '@justeattakeaway/pie-icons-react/dist/IconCalendar';
```

#### Props

Icons accept any standard attribute, except for `width` and `height` since those are set implicitly by using the `size` prop.

##### `size`

Icons are made available in different size variants:

- small
- large, when its name has the `Large` suffix

Small icons default size is `xs` and can use one of the following pre-determined values for `size`: `xxs`, `xs`, `s`, `m`, `l`, `xl`, and `xxl`. You can learn more about small icon sizes [here](https://www.pie.design/foundations/iconography/#small-icon-set).

Large icons `size` default and minimum value is `32`. Values larger than the minimum must be multiples of `8`, otherwise will be automatically rounded. You can learn more about large icon sizes [here](https://www.pie.design/foundations/iconography/#large-icon-set).

Example:

```tsx
<IconAlertTriangle size="l" />
<IconAlertTriangleLarge size={40} />
```

### Styles

The React icons package doesn't provide CSS styles. CSS classes `c-pieIcon c-pieIcon--{iconName}` are available for consuming applications to add the styles they require.

### Tree shaking

By using ES imports like `import { IconCalendar } from '@justeattakeaway/pie-icons-react'` with Webpack v4+ or Rollup, unused exports in this module will be automatically eliminated.

If your application doesn't support ES Modules, you can still consume this library as a CommonJS module, but you will lose the tree-shaking capability. If so, you can use the per-file icons from the `/dist` folder:

```tsx
import AlertTriangle from "@justeattakeaway/pie-icons-react/dist/AlertTriangle";
```

## Contributing

Before starting please read our [contributing guide](https://pie.design/engineers/contributing/)

### Adding new icons

Icons should be added as SVGs to the main pie-icons package and published, before simply incrementing the dependency of `pie-icons` in the `pie-icons-react` package, to generate the new set of React components.

The PIE iconset is managed by our PIE design system team and new icon requests should go through them to ensure that they are designed inline with our standards and guildelines. Please reach out to PIE design system team using #help-designsystem slack channel.

### Building the Module

Run `yarn build` from the project level or `yarn turbo run build --filter=pie-icons-react` from the root level to compile the module.

## Icon list

You can check the list of all the icons on our PIE documentation site: https://pie.design/foundations/iconography/library/.

## Credits

This package was heavily inspired by the excellent [`vue-feather-icons`](https://github.com/egoist/vue-feather-icons) package.