@itravelholidays/polaris-icons

This package exports a JavaScript file containing the Polaris icons for building on the iTravelHolidays platform, and contains SVG files in the /dist/svg directory.

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.

Installation

1. Install Polaris React if you haven't already

2. Install Polaris icons as a dependency:

   npm:

   npm install @itravelholidays/polaris-icons --save

   yarn:

   yarn add @itravelholidays/polaris-icons

Usage

Import the Icon component from Polaris React and any icon from Polaris icons into your project.

1. Import the icon component from Polaris React:

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

2. Import an icon from Polaris icons:

   import {AddMajor} from '@itravelholidays/polaris-icons';

3. Use the icon in your component:

   <Icon source={AddMajor} />

SVG files

For projects that don't use React, icons are also available as *.svg files in the dist/svg folder.

Suggested CSS and markup for projects that aren't using the Polaris HTML and CSS components:

<style>
  .polaris-icon {
    display: block;
    height: 2rem;
    width: 2rem;
    max-height: 100%;
    max-width: 100%;
    margin: auto;
  }
</style>

<span class="polaris-icon">
  <svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
    <!-- SVG content here -->
  </svg>
</span>

Contributing 🙌

To add, remove, or rename icons, follow the contributing guide.

Licenses 📝

• Source code is under a custom license based on MIT.