@justeattakeaway/pie-icons-webc

pie-icons-webc

Shared PIE Icon Components built using Lit Web Components.

This package provides the PIE iconset as importable Web Components, to ensure icons are used to PIE guidelines for sizing.

The base pie-icons package is used to provide the SVGs that are compiled into Lit web components that can be imported into any application.

---

---

Usage

Installation

Add the module to your project

yarn add @justeattakeaway/pie-icons-webc

Usage

Vanilla Javascript

1. Import a specific icon from its entry point (recommended)

// Importing a specific icon directly from its entry point (recommended for tree-shaking benefits)
import { IconCalendarFilledLarge } from '@justeattakeaway/pie-icons-webc/IconCalendarFilledLarge';

function renderIcon() {
    // Using the imported icon
    const iconElement = new IconCalendarFilledLarge();
    document.body.appendChild(iconElement);
}

1. Import a specific icon from its entry point without a reference (recommended)

// Importing a specific icon without keeping a reference from its entry point
import '@justeattakeaway/pie-icons-webc/IconCalendarFilledLarge';

// Rest of code does not directly reference IconCalendarFilledLarge however the web component has been registered in the browser

// In some HTML:
// <div>
//   <icon-calendar-filled-large></icon-calendar-filled-large>
// <div>

1. Importing all icons at once (not recommended)

// Importing all icons from the library (not recommended)
import * as icons from '@justeattakeaway/pie-icons-webc';

function renderIcon() {
    // Using a specific icon
    const iconElement = new icons.IconCalendarFilledLarge();
    document.body.appendChild(iconElement);
}

[!WARNING] While it is also possible to import individual components from the overall bundle, we don't recommend this because it is likely that the import will be tree-shaken unless you are referencing the imported object in your code.

// Not recommended -  Webpack v4+ or Rollup should treeshake but be careful
import { IconAppRestaurant } from '@justeattakeaway/pie-icons-webc';
// Not recommended
import { IconAppRestaurant } from '@justeattakeaway/pie-icons-webc';

Lit Components

import '@justeattakeaway/pie-icons-webc/IconAppRestaurant';

export class MyAmazingComponent extends LitElement {
  render () {
    return html`
      <h2>
        This is a heading
        <icon-app-restaurant size="xl" />
      </h2>`;
  }
}

React

To import from the package root:

// Please note we include /dist/ in the path only for React exports. This is due to how we have setup React exports to work with frameworks such as NextJS.
import { IconAlertTriangleLarge, IconCalendar } from "@justeattakeaway/pie-icons-webc/dist/react";

// If your app can support the exports set in the package.json, you can also import like so (exclude 'dist'):
import { IconAlertTriangleLarge, IconCalendar } from "@justeattakeaway/pie-icons-webc/react";

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

To import a single icon:

// Please note we include /dist/ in the path only for React exports. This is due to how we have setup React exports to work with frameworks such as NextJS
import { IconCalendar } from "@justeattakeaway/pie-icons-webc/dist/react/IconCalendar";

// If your app can support the exports set in the package.json, you can also import like so (exclude 'dist'):
import { IconCalendar } from "@justeattakeaway/pie-icons-webc/react/IconCalendar";

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

TODO: Add Vue usage

If you require icons for a Vue app, you can either use these icons, or use our native Vue component package – pie-icons-vue.

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:

• regular
• large, when its name has the Large suffix

Regular icons default size is xs and can use one of the following pre-determined values for size: xs, s, m, l, xl, and xxl. You can learn more about regular icon sizes here.

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.

Example:

<icon-alert-triangle size="s" />
<icon-alert-triangle-large size="80" />

Tree shaking

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

If you can't use a tree-shaking compatible build tool, then you can use the per-file icons from the /icons directory, e.g. import IconCalendar from '@justeattakeaway/pie-icons-webc/IconCalendar'.

Browser Support

The component extends @justeattakeaway/browserslist-config-pie package for the list of browsers to support.

Contributing

Before starting please read our contributing guide

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-webc package, to generate the new set of Web Components.

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

Building the Module

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

Icon list

You can check the list of all the icons on our documentation site.