BadgeList

Presents a list of short details with added visual information.

BadgeList

To implement BadgeList component into your project you’ll need to add the import:

import BadgeList, { BadgeListItem } from "@kiwicom/orbit-components/lib/BadgeList";

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

<BadgeList>
<BadgeListItem icon={<Airplane />}>Lorem ipsum dolor sit amet</BadgeListItem>
</BadgeList>

Props

Table below contains all types of the props available in BadgeList component.

NameTypeDefaultDescription
childrenReact.NodeThe content of the BadgeList.
dataTeststringOptional prop for testing purposes.
idstringSet id for BadgeList

BadgeListItem

| Name | Type | Default | Description | | children | React.Node | | The content of the BadgeListItem. | | icon | React.Node | | The displayed icon on the left. | | type | enum | "neutral" | The color type of the BadgeListItem. |

enum

type
"neutral"
"info"
"success"
"warning"
"critical"