Skip to content
FormsInteractive playground

RadioGroup

One choice among several alternatives.

Preparing the playground…
Text and Markdown example
RadioGroup · Example
1<RadioGroup defaultValue="pro" aria-label="Plan"><div style={{display:"flex",gap:8}}><RadioGroupItem value="starter" id="starter" /><Label htmlFor="starter">Starter</Label></div><div style={{display:"flex",gap:8}}><RadioGroupItem value="pro" id="pro" /><Label htmlFor="pro">Pro</Label></div></RadioGroup>
Read documentation in Markdown

How to use it

Each RadioGroupItem needs a unique value and label. The group shares state through value and onValueChange.

Import

React / Next.js
1import { RadioGroup, RadioGroupItem } from "@kivora/nextjs";

Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.

API reference 0.2.0

Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.

PropertyTypeDescription
aria-labelstringAccessible name of the control.
asChildbooleanApply props and behavior to a single compatible child element.
childrenReactNodeContent or child elements of the component.
classNamestringAdditional CSS classes to customize the element.
defaultCheckedbooleanInitial selection of the control.
defaultValuestringInitial value when the component manages its own state.
dir"ltr" | "rtl"Interface reading direction.
disabledbooleanDisable interaction with the control.
formstringConfigures form. The type describes the supported values and structure.
idstringElement identifier; associates labels and descriptions.
loopbooleanConfigures loop. The type describes the supported values and structure.
namestringName used to identify the control in forms.
onChangeChangeEventHandler<HTMLDivElement, Element>Change event. Check the type: some controls return an object, others a DOM event.
onClickMouseEventHandler<HTMLDivElement>Action performed when the element is activated.
onSubmitSubmitEventHandler<HTMLDivElement>Form submission event.
onValueChange((value: string) => void)Receives the value after an interaction.
orientation"horizontal" | "vertical"Horizontal or vertical axis.
requiredbooleanIndicates that a value is required.
roleAriaRoleSemantic role of the element. Keep the default role unless a change is justified.
styleCSSPropertiesReact inline styles.
tabIndexnumberKeyboard focus order and availability.
titlestringTitle or supplementary information.
valuestring | nullControlled value. Update it from the change callback.

Subcomponents and composition

Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.

RadioGroup23 properties
RadioGroup · TypeScript
1RadioGroup: React.ForwardRefExoticComponent<RadioGroupProps & React.RefAttributes<HTMLDivElement>>
RadioGroupItem20 properties
PropertyTypeDescription
valueRequiredstringControlled value. Update it from the change callback.
aria-labelstringAccessible name of the control.
asChildbooleanApply props and behavior to a single compatible child element.
checkedbooleanControlled selection state.
childrenReactNodeContent or child elements of the component.
classNamestringAdditional CSS classes to customize the element.
defaultCheckedbooleanInitial selection of the control.
defaultValuestring | number | readonly string[]Initial value when the component manages its own state.
disabledbooleanDisable interaction with the control.
idstringElement identifier; associates labels and descriptions.
invalidbooleanEnable the visual error state.
onChangeChangeEventHandler<HTMLButtonElement, Element>Change event. Check the type: some controls return an object, others a DOM event.
onClickMouseEventHandler<HTMLButtonElement>Action performed when the element is activated.
onSubmitSubmitEventHandler<HTMLButtonElement>Form submission event.
requiredbooleanIndicates that a value is required.
roleAriaRoleSemantic role of the element. Keep the default role unless a change is justified.
styleCSSPropertiesReact inline styles.
tabIndexnumberKeyboard focus order and availability.
titlestringTitle or supplementary information.
type"button" | "submit" | "reset"Operation type or mode; values depend on the component.
RadioGroupItem · TypeScript
1RadioGroupItem: React.ForwardRefExoticComponent<RadioGroupItemProps & React.RefAttributes<HTMLButtonElement>>
API generated from @kivora/nextjs 0.2.0View package