Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
__tests__
Icon.stories.js
IconList.js
README.md
consts.js
index.js
index.js.flow

README.md

Icon

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.
reverseOnRtl boolean false If true, the icon will be reversed if theme.rtl is set to true.

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.
You can’t perform that action at this time.