Stable in React

Radio

One radio button of a RadioGroup.

Loading React 19.3.1…

Hover a part or use it. The code follows. · Loading React…

91Tests passing in React · 0 failing

9.8 KiBSize

Not measured yetMemory

Not measured yetSpeed

productdevbook and 18 upstream authors8 commits · last Nov 3

Install#

One package per framework. Radio's parts come from it; the anatomy tab at the top shows how they nest.

bun add @▢▢▢▢/react

Two parts. The example uses two of them; the data does not say which are required.

Radio.RootRepresents the radio button itself.
Radio.IndicatorIndicates whether the radio button is selected.

Examples#

Radio is shown in RadioGroup's examples; it has no demo of its own.

Styling and accessibility#

The parts ship no styles. Style their states with these attributes; the CSS tab at the top has a sheet. The same CSS works in all five frameworks.

[data-checked]Present when the radio is checked. On Root, Indicator.
[data-unchecked]Present when the radio is not checked. On Root, Indicator.
[data-disabled]Present when the radio is disabled. On Root, Indicator.
[data-readonly]Present when the radio is readonly. On Root, Indicator.
[data-required]Present when the radio is required. On Root, Indicator.
[data-valid]Present when the radio is in a valid state (when wrapped in Field.Root). On Root, Indicator.
[data-invalid]Present when the radio is in an invalid state (when wrapped in Field.Root). On Root, Indicator.
[data-touched]Present when the radio has been touched (when wrapped in Field.Root). On Root, Indicator.
[data-dirty]Present when the radio's value has changed (when wrapped in Field.Root). On Root, Indicator.
[data-filled]Present when the radio is checked (when wrapped in Field.Root). On Root, Indicator.
[data-focused]Present when the radio is focused (when wrapped in Field.Root). On Root, Indicator.
[data-starting-style]Present when the radio indicator begins animating in. On Indicator.
[data-ending-style]Present when the radio indicator is animating out. On Indicator.

Keyboard

ArrowDownArrowUpArrowLeftArrowRightSelects the next or previous radio of the group On Root.

Set for you

role="radio", aria-checkeda screen reader reads it as a radio button and whether it is chosenRoot
aria-labelledby to an associated labela <label> or Field label names the radioRoot
a hidden <input type="radio"> with aria-hidden="true" and tabindex="-1"the form gets the value without a second control to read or tab toRoot
renders a <span> with your markthe dot is decoration; the state is on RootIndicator

API reference#

7 props across 2 parts, in React syntax, and className, style, render once for every part. Open a row to try it.

Filter props

Radio · all parts

Shared propsEvery part that renders an element takes these.

classNameCSS class applied to the element, or a function that returns a class based on the component's state.string | ((state: State) => string | undefined)

styleStyle applied to the element, or a function that returns a style object based on the component's state.React.CSSProperties | ((state: State) => React.CSSProperties | undefined)

renderAllows you to replace the component's HTML element with a different tag, or compose it with another component.React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, State>

Use it in React#

What differs from the React API. Switch the framework at the top of the page.

@▢▢▢▢/react is the React 19 package. Its parts, props, data attributes and error messages are upstream Base UI's, and upstream's own tests run against it.

Parts
Each component is its own entry point and exports one namespace named after it.
```
import { Switch } from '@base-ui-next/react/switch'

export function Example() {
  return (
    <Switch.Root>
      <Switch.Thumb />
    </Switch.Root>
  )
}
```
A part renders the element its API reference names, such as a <span> for Switch.Root.
Props and events
Props and callbacks have upstream's names and signatures: onCheckedChange(checked, details), onOpenChange(open, details), onValueChange(value, details). details carries reason, event, cancel() and allowPropagation(). Native handlers are React's (onClick, onKeyDown), and event.preventBaseUIHandler() stops a part's own handler.
Styling
className takes a string or a function (state) => string; style takes an object or a function (state) => object. The state's data-* attributes are on the element for CSS.
render
render takes an element (render={<a href="/docs" />}) or a function (props, state) => element that spreads props on what it returns.
Refs
ref reaches the part's element. Imperative handles are ref props, as upstream: inputRef, and actionsRef ({ validate } on Field and Form, { unmount, close } on Dialog).
Binding
A part is controlled when its value prop (checked, open, value) is set, and uncontrolled with the default form (defaultChecked, defaultOpen, defaultValue). React has no two-way binding: pair the value with its change callback.
From @base-ui/react
Change the import from @base-ui/react/<component> to @▢▢▢▢/react/<component>.
From @base-ui/react
Nothing else changes: props, parts, data attributes and errors are the same.