@heycar-uikit/icons

HeyCar-UIKit - Icons

Installation

To install and save in your package.json dependencies, run the command below using npm:

npm install @heycar-uikit/icons

Usage

Semantic vector graphics. Before using icons, you need to install import icons using one of these two options:

• Option 1:

import CarIcon from '@heycar-uikit/icons/Car';
import CloseIcon from '@heycar-uikit/icons/Close';

function App() {
  return (
    <div>
      <Button
        leftIcon={<CarIcon />}
        size="large"
        color="primary"
        variant="outlined"
      >
        Hello World
      </Button>
      <CloseIcon />
    </div>
  );
}

• Option 2:

import { Car, Close } from '@heycar-uikit/icons';

function App() {
  return (
    <div>
      <Button
        leftIcon={<CarIcon />}
        size="large"
        color="primary"
        variant="outlined"
      >
        Hello World
      </Button>
      <CloseIcon />
    </div>
  );
}

Documentation and sandbox

Storybook documentation and sandbox.

Changelog

5.0.0 (2023-03-15)

Features

• accordion: remove hover state (#163) (df62524)
• badge: restrict to 3 colors (#165) (3a1f408)
• logo: update logo variant names (#164) (6b94211)
• typography: update typography to match designs (#160) (9a601a7)

BREAKING CHANGES

• badge: using a color other than primary, secondary or tertiary will render the badge in primary state

HEYUI-268

• defaults to primary styling the if the color prop value is not recognised

• feat(badge): restric to 3 colors

The Badge should only be used in primary, secondary or tertiary

• badge: using a color other than primary, secondary or tertiary will render the badge in primary state

HEYUI-268

• update various tests

• update test