Icons

We use icons to draw attention to specific actions in our products.

To implement Icon component into your project you need to know its name. You can find it in the list of all icons. Then just add an import of the icon:

import Airplane from "@kiwicom/orbit-components/lib/icons/Airplane";

After adding import into your project you can use it simply like:

<Airplane />

Props

Table below contains all types of the props available for icons in general.

Name Type Default Description
className string The optional className of Icon.
color enum currentColor The color of the Icon.
customColor string The customColor of the Icon. See Functional specs
dataTest string Optional prop for testing purposes.
size enum "medium" The size of the Icon.

enum

color size
"attention" "small"
"primary" "medium"
"secondary" "large"
"tertiary"
"info"
"success"
"warning"
"critical"

Functional specs

  • If you don't pass customColor or color prop to Icon, it will inherit color from parent container with currentColor by default.

For guidelines on how to work with icons, please check Icons page. You can also find list of all our icons.