@justeattakeaway/pie-icons-webc

pie-icons-webc

Shared PIE Icon Components built using native 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 native web components that can be imported into any application.

---

---

Usage

Installation

Add the module to your project

yarn add @justeattakeaway/pie-icons-webc

Applications

// Only import what you need!
import '@justeattakeaway/pie-icons-webc/icons/IconAppRestaurant';

// Note, we don't recommend referencing named exports such as:
// `import { IconAppRestaurant } from '@justeattakeaway/pie-icons-webc`
// As this will require you to make a call to the icon so that it doesn't get tree-shaken by your build tool

Within the context of a Lit app, that will look like:

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

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

If you require icons for a React application, you can either use these icons, or use our native React component package – pie-icons-react.

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/icons/IconCalendar'.

Browser Support

The component extends @justeat/browserslist-config-fozzie 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.