@revt/diverse-icons v0.0.16

@revt/diverse-icons

This package exports a JavaScript file containing the Diverse icons partners can use to build on the Revt platform, and contains SVG files in the /dist/svg directory (SVG usage instructions).

Browse and search Diverse icons:

Getting started

Although it’s possible to use this package directly, we recommend using the icons in this package through Diverse React in combination with the Icon component.

Installation

1. Install Diverse React (instructions) if you haven’t already

2. Diverse icons as a dependency:

   Using npm:

   npm install @revt/diverse-icons --save

   Or, using Yarn:

   yarn add @revt/diverse-icons

   Or, using pnpm:

   pnpm add @revt/diverse-icons

Usage

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

1. Import the icon component from Diverse React:

   import { Icon } from '@revt/diverse';

2. Import an icon from Diverse icons:

   import { PlusIcon } from '@revt/diverse-icons';

3. Pass the imported Diverse icon to the source prop of the Icon component:

   <Icon source={PlusIcon} />

SVG files

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

Browse the list of SVG files, hosted on the unpkg CDN (Content Delivery Network).

Suggested CSS and markup for projects that aren’t using the Diverse HTML and CSS components:

.Custom-Diverse-Icon {
  display: block;
  height: 2rem; /* or value equivalent to 20px */
  width: 2rem; /* or value equivalent to 20px */
  max-height: 100%;
  max-width: 100%;
  margin: auto;
}

.Custom-Diverse-Icon__Svg {
  position: relative;
  display: block;
  width: 100%;
  max-width: 100%;
  max-height: 100%;

  /* Icon color */
  fill: #000;
}

<span class="Custom-Diverse-Icon">
  <svg viewBox="0 0 20 20" class="Custom-Diverse-Icon__Svg" focusable="false" aria-hidden="true">
    <path fill="currentColor" d="M7 13h6v6H7z" />
    <path
      d="M19.664 8.252l-9-8a1 1 0 0 0-1.328 0L8 1.44V1a1 1 0 0 0-1-1H3a1 1 0 0 0-1 1v5.773L.336 8.252a1.001 1.001 0 0 0 1.328 1.496L2 9.449V19a1 1 0 0 0 1 1h14a1 1 0 0 0 1-1V9.449l.336.299a.997.997 0 0 0 1.411-.083 1.001 1.001 0 0 0-.083-1.413zM16 18h-2v-5a1 1 0 0 0-1-1H7a1 1 0 0 0-1 1v5H4V7.671l6-5.333 6 5.333V18zm-8 0v-4h4v4H8zM4 2h2v1.218L4 4.996V2z"
      fill-rule="evenodd"
    />
  </svg>
</span>

Contributing 🙌

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

Licenses 📝

• Source code is under a custom license based on MIT. The license restricts Diverse icons usage to applications that integrate or interoperate with Revt software or services, with additional restrictions for external, stand-alone applications.
• All icons and images are licensed under the Diverse Design Guidelines License Agreement.