Skip to content

README.md

Latest commit

 

History

History
33 lines (21 loc) · 1.02 KB

README.md

File metadata and controls

33 lines (21 loc) · 1.02 KB
Raw

@ippon-ui/icons

The Ippon UI icon font, generated from Ionicons. It ships the compiled font, its stylesheet and the TypeScript types of every available icon name.

Installation

The font is bundled into your application, so install it as a dev dependency:

npm install -D @ippon-ui/icons

Usage

In most cases you consume the icons through the higher-level packages:

  • the stylesheet is re-exported by @ippon-ui/styles as @ippon-ui/styles/icons/ionicons.css;
  • the @ippon-ui/react IpponIcon and IpponIon components render them by name.

This package also exposes the icon names as types, so you can type your own props against the available icons:

import type { IconClassic, IconLogo, IconVariant } from '@ippon-ui/icons';

type Icon = {
  name: IconClassic | IconLogo;
  variant?: IconVariant; // 'sharp' | 'outline'
};

License

Apache-2.0 © Ippon Technologies