Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@comfortdelgro/compass-icons

comfortdelgro793MIT1.4.0TypeScript support: included

Icons for React Compass Design System

readme

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

changelog

@comfortdelgro/compass-icons

1.4.0

Minor Changes

  • 0de27fb: Update new icons

1.3.0

Minor Changes

  • 770437a: Update

1.3.0

Minor Changes

  • 6827a4d: Update named import

1.1.0

Minor Changes

  • c062799: Enable named export for /iconify

1.0.0

Major Changes

  • 28f6b70: Restructure folder structure

0.12.0

0.11.0

0.10.0

0.10.0

Minor Changes

  • baeddd7: Add flag icons and fix bugs

0.9.0

Minor Changes

  • ce4513b: compass-icons: add mission country flags, fix build. react-compass: add html attributes props to components, add prefix for textfield, set auto height for toast title, add otp input component, fix datepicker skipping 1 month when next clicked, error state for dropdown, editable tag

0.8.0

Minor Changes

  • aa572d8: compass-icon now can be imported the whole package, table multi sort is fixed, date picker maxValue is now useable

0.7.0

Minor Changes

  • 3248b8b: Add more icons to workbench

0.6.0

Minor Changes

  • 433183b: 1. Add country flag icons 2. Add new components: tag input & rich text render 3. Fix: wrong alignment of checkbox, drag&drop list doesn't work with complex child

0.5.0

Minor Changes

  • bf0c74a: 1. add more icons to compass-icon 2. Encapsulate table component and fix its props 3. Add more docs 4. Add more variants for tagbox 5. Fix date picker granularity 6. Fix accordion box-sizing 7. Add version 2 of Carousel

0.4.0

Minor Changes

  • 6402cf3: 1. add more icons for workbench to compass-icon 2. add new components: carousel version 2, upload version 2, table version 2, multiple dropdown, box component, colors, Typography, Drag & drop list, 3. Fix bugs: position of tooltip, export of Tabs component, z-index standard for all components so that tooltip can work well with modal/dialog,

0.3.0

Minor Changes

  • 83f5bf6: Add more components and fix few bugs on current components.

0.2.1

Patch Changes

  • e813311: Update build script

0.2.0

Minor Changes

  • bc9509b: add more icons and components: calendar, header, footer, card, chart, progress bar, list, accordion, menu-list, timepline, upload, carousel. fix bugs: textarea css prop duplication, avatar group's errors in icon sizing & animation, searfield's close icon duplication when typinng, card's styling not matching with design.

0.1.1

Patch Changes

  • ddbf1ad: utils now included back in react-compass exports and updated READMEs for both compass-icons and react-compass packages.

0.1.0

Minor Changes

  • 0631625: Add more components such as table, pagination, card and checkbox. @comfortdelgro/compass-icons package is introduced with Icon component (aliased to FontAwesomeIcon) now directly exported from the react-compass package. We now support both CommonJS and ESM. The icons package also support both formats for use with Iconify and as pure React components.