5.3.3 • Published 5 months ago

@highlight-ui/icon v5.3.3

Weekly downloads
-
License
MIT
Repository
-
Last release
5 months ago

npm personio.design storybook.personio.design

@highlight-ui/icon

Installation

Using npm:

npm install @highlight-ui/icon

Using yarn:

yarn add @highlight-ui/icon

Using pnpm:

pnpm install @highlight-ui/icon

In order to use font-awesome, it is necessary to include per your usage! It is not shipped in this package.

In your (S)CSS file:

@import url('@highlight-ui/icon');

Once the package is installed, you can import the library:

import { Icon } from '@highlight-ui/icon';

Usage

import React, { useState } from 'react';
import { Icon } from '@highlight-ui/icon';

export default function IconExample() {
  return <Icon name="map" color="icon-critical" type="light" />;
}

Props 📜

PropTypeRequiredDefaultDescription
namestringYesSpecify a name of the icon
colorIconColorTokenNoSpecify a color of the icon
sizenumberNo14Specify the size of the icon
spinbooleanNofalseSpecifies whether the icon will be spinning (using CSS animation) or not
type'regular', 'light', 'solid'NoregularSpecify a font family for the icon
blockbooleanNofalseMakes the component behave as a block element (take up the whole available space)
aria-hiddenReact.AriaAttributes['aria-hidden']NoIndicates whether the element is exposed to an accessibility API

Custom types 🔠

TypeValuesDescription
IconColorToken"Icon" and "Icon On" color token names

Contributing 🖌️

Please visit personio.design for usage guidelines and visual examples.

If you're interested in contributing, please visit our contribution page.

@highlight-ui/tokens@highlight-ui/utils-commons
@highlight-ui/anchor@infinitebrahmanuniverse/nolb-_hig@everything-registry/sub-chunk-395@highlight-ui/sandbox-form-field@highlight-ui/sandbox-menu@highlight-ui/sandbox-multiselect-tag@highlight-ui/sandbox-progress-tracker@highlight-ui/sandbox-search-input@highlight-ui/sandbox-searchable-sub-label-select@highlight-ui/sandbox-select-low-domy@highlight-ui/sandbox-tag@highlight-ui/select@highlight-ui/toast@highlight-ui/color-picker@highlight-ui/date-time-picker@highlight-ui/tag@highlight-ui/toggle-input@highlight-ui/accordion@highlight-ui/alert@highlight-ui/avatar@highlight-ui/button@highlight-ui/drag-and-drop@highlight-ui/empty-state@highlight-ui/file-management@highlight-ui/form-field@highlight-ui/link@highlight-ui/menu@highlight-ui/month-navigation@highlight-ui/pagination@highlight-ui/progress-tracker@highlight-ui/sandbox-date-time-picker@zalastax/nolb-_hig
5.3.3

5 months ago

5.3.2

7 months ago

5.3.1

7 months ago

5.3.0

7 months ago

5.0.1

10 months ago

5.1.4

10 months ago

5.1.3

10 months ago

5.3.0-r18.0

8 months ago

5.1.2

10 months ago

5.1.1

10 months ago

5.1.0

10 months ago

5.2.15

7 months ago

5.2.14

7 months ago

5.2.13

7 months ago

5.2.12

7 months ago

5.2.11

8 months ago

5.2.10

8 months ago

5.2.9

8 months ago

5.2.8

8 months ago

5.2.7

9 months ago

5.2.6

9 months ago

5.2.5

9 months ago

5.2.4

9 months ago

5.2.3

10 months ago

5.2.2

10 months ago

5.2.1

10 months ago

5.2.0

10 months ago

4.1.8

1 year ago

4.1.9

1 year ago

5.0.0

11 months ago

4.1.7

1 year ago

4.1.4

1 year ago

4.1.6

1 year ago

4.1.5

1 year ago

4.0.21

1 year ago

4.0.27

1 year ago

4.0.26

1 year ago

4.0.29

1 year ago

4.0.28

1 year ago

4.0.23

1 year ago

4.0.22

1 year ago

4.0.25

1 year ago

4.0.24

1 year ago

4.0.30

1 year ago

4.1.3

1 year ago

4.0.32

1 year ago

4.0.31

1 year ago

4.1.0

1 year ago

4.1.2

1 year ago

4.1.1

1 year ago

4.0.37

1 year ago

4.0.34

1 year ago

4.0.33

1 year ago

4.0.36

1 year ago

4.0.35

1 year ago

4.0.19

2 years ago

4.0.16

2 years ago

4.0.17

2 years ago

4.0.15

2 years ago

4.0.14

2 years ago

4.0.0-alpha.1

2 years ago

4.0.5

2 years ago

4.0.4

2 years ago

4.0.10

2 years ago

4.0.7

2 years ago

4.0.6

2 years ago

4.0.1

2 years ago

4.0.0

2 years ago

4.0.3

2 years ago

4.0.2

2 years ago

4.0.12

2 years ago

4.0.11

2 years ago

4.0.13

2 years ago

4.0.9

2 years ago

4.0.0-alpha.0

2 years ago

3.0.28

2 years ago

3.0.30

2 years ago

3.0.29

2 years ago

3.0.27

2 years ago

3.0.23

2 years ago

3.0.24

2 years ago

3.0.22

2 years ago

3.0.25

2 years ago

3.0.26

2 years ago

3.0.21

3 years ago

3.0.20

3 years ago

3.0.18

3 years ago

3.0.19

3 years ago

3.0.17

3 years ago

3.0.16

3 years ago

3.0.14

3 years ago

3.0.15

3 years ago

3.0.13

3 years ago

3.0.12

3 years ago

3.0.10

3 years ago

3.0.11

3 years ago

3.0.9

3 years ago

3.0.8

3 years ago

3.0.7

3 years ago

3.0.6

3 years ago

3.0.5

3 years ago

3.0.4

3 years ago

3.0.3

3 years ago

3.0.2

3 years ago

3.0.1

3 years ago

2.1.6

3 years ago

2.1.8

3 years ago

2.1.7

3 years ago

2.1.9

3 years ago

3.0.0

3 years ago

2.1.5

3 years ago

2.1.2

3 years ago

2.1.1

3 years ago

2.1.4

3 years ago

2.1.3

3 years ago

2.0.7

3 years ago

2.1.0

3 years ago

2.0.6

3 years ago

2.0.5

3 years ago

2.0.4

3 years ago

2.0.3

3 years ago

2.0.2

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.1.3

3 years ago

1.1.2

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago