Compass Icons

Icons to be used with ComfortDelGro's Compass Design System Components. See here.

Getting started

Installation

To get started, run

yarn add @comfortdelgro/compass-icons

or

npm install @comfortdelgro/compass-icons

or

pnpm install @comfortdelgro/compass-icons

Make sure you have all the required peer dependencies installed in the first place.

Usage

Use as React components,

import CrownIcon from '@comfortdelgro/compass-icons/react/crown'
;() => <CrownIcon size={20}>Click Me</CrownIcon>

Use with Iconify

import crownIcon from '@comfortdelgro/compass-icons/iconify/crown'
import {Icon} from '@iconify/react'
;() => <Icon icon={crownIcon} size={20} />

Reporting a Bug

If you spot a bug, inconsistency, or typo, please open a bug issue. Better yet, submit a pull request to address it.

Feature Requests

If you have an idea, we would love to hear about it. The best way to suggest a feature is to open a feature issue.

License

MIT © 2022