ListChoice

Shows one of a selectable list of items with similar structures.

ListChoice

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

import ListChoice from "@kiwicom/orbit-components/lib/ListChoice";

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

<ListChoice title="My Choice" />

Props

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

NameTypeDefaultDescription
dataTeststringOptional prop for testing purposes.
idstringSet id for ListChoice
descriptionTranslationThe additional info about the ListChoice.
disabledbooleanfalseIf true, the ListChoice won’t perform any onClick action and if selectable is set to true, the check box glyph will use disabled state.
iconReact.NodeThe icon on the left of the ListChoice.
onClickevent => void \| PromiseFunction for handling onClick event.
selectablebooleanfalseIf true, the check box glyph appears on the right size and it will be possible to select the ListChoice.
selectedbooleanfalseIf true, the check box glyph will be checked.
titleTranslationThe title of the ListChoice.
actionReact.NodeArea for action elements, like Button