To implement ChoiceGroup component into your project you'll need to add the import:

import ChoiceGroup from "@kiwicom/orbit-components/lib/ChoiceGroup";
import Radio from "@kiwicom/orbit-components/lib/Radio";

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

<ChoiceGroup label="What was the reason for your cancellation?">
  <Radio label="Reason one" value="one" />
  <Radio label="Reason two" value="two" />
  <Radio label="Reason three" value="three" />
</ChoiceGroup>

Props

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

Name Type Default Description
dataTest string Optional prop for testing purposes.
children Array Could accept or
error Translation The error to display beneath the ChoiceGroup. Also, the Checkboxes/Radios will turn red when you pass some valuue.
label Translation Heading text of
labelSize enum "normal" The size type of Heading.
labelElement enum "h4" The element used to render the label into.
onChange event => void \| Promise Function for handling onChange event. See Functional specs

enum

labelElement labelSize
"h2" "normal"
"h3" "large"
"h4"
"h5"
"h6"

Functional specs

  • onChange props in or will be overrided by internal onChange function
  • If you want to handle selecting field, pass onChange to and it will be always triggered when or should change
  • onChange will return SyntheticEvent of field that should change
    <ChoiceGroup onChange={ev => doSomething(ev)}>
    <Radio label="Reason one" value="one" />
    <Radio label="Reason two" value="two" />
    <Radio label="Reason three" value="three" />
    </ChoiceGroup>