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>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.
| Property | Type | Description |
|---|---|---|
aria-label | string | Accessible name of the control. |
asChild | boolean | Apply props and behavior to a single compatible child element. |
children | ReactNode | Content or child elements of the component. |
className | string | Additional CSS classes to customize the element. |
defaultChecked | boolean | Initial selection of the control. |
defaultValue | string | Initial value when the component manages its own state. |
dir | "ltr" | "rtl" | Interface reading direction. |
disabled | boolean | Disable interaction with the control. |
form | string | Configures form. The type describes the supported values and structure. |
id | string | Element identifier; associates labels and descriptions. |
loop | boolean | Configures loop. The type describes the supported values and structure. |
name | string | Name used to identify the control in forms. |
onChange | ChangeEventHandler<HTMLDivElement, Element> | Change event. Check the type: some controls return an object, others a DOM event. |
onClick | MouseEventHandler<HTMLDivElement> | Action performed when the element is activated. |
onSubmit | SubmitEventHandler<HTMLDivElement> | Form submission event. |
onValueChange | ((value: string) => void) | Receives the value after an interaction. |
orientation | "horizontal" | "vertical" | Horizontal or vertical axis. |
required | boolean | Indicates that a value is required. |
role | AriaRole | Semantic role of the element. Keep the default role unless a change is justified. |
style | CSSProperties | React inline styles. |
tabIndex | number | Keyboard focus order and availability. |
title | string | Title or supplementary information. |
value | string | null | Controlled 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
| Property | Type | Description |
|---|---|---|
valueRequired | string | Controlled value. Update it from the change callback. |
aria-label | string | Accessible name of the control. |
asChild | boolean | Apply props and behavior to a single compatible child element. |
checked | boolean | Controlled selection state. |
children | ReactNode | Content or child elements of the component. |
className | string | Additional CSS classes to customize the element. |
defaultChecked | boolean | Initial selection of the control. |
defaultValue | string | number | readonly string[] | Initial value when the component manages its own state. |
disabled | boolean | Disable interaction with the control. |
id | string | Element identifier; associates labels and descriptions. |
invalid | boolean | Enable the visual error state. |
onChange | ChangeEventHandler<HTMLButtonElement, Element> | Change event. Check the type: some controls return an object, others a DOM event. |
onClick | MouseEventHandler<HTMLButtonElement> | Action performed when the element is activated. |
onSubmit | SubmitEventHandler<HTMLButtonElement> | Form submission event. |
required | boolean | Indicates that a value is required. |
role | AriaRole | Semantic role of the element. Keep the default role unless a change is justified. |
style | CSSProperties | React inline styles. |
tabIndex | number | Keyboard focus order and availability. |
title | string | Title 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