RadioGroup

Radio fieldset that propagates names to child radio controls.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { RadioGroup } from "@tavojs/ui/radio-group";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/radio-group.

When to use

Use it when

Use `RadioGroup` to group radio options

Choose something else when

Avoid RadioGroup when wrapping controls without labels or accessible names.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

RadioGroup example

TSXCreate: src/components/examples/RadioGroupExample1.tsx

tsximport { RadioGroup } from "@tavojs/ui/radio-group";
import { FormControlLabel, Radio } from "@tavojs/ui";

export function RadioGroupExample1() {
  return (
    <>
      <RadioGroup name="plan" aria-label="Plan">
        <FormControlLabel label="Starter" control={<Radio name="plan" value="starter" defaultChecked />} />
        <FormControlLabel label="Scale" control={<Radio name="plan" value="scale" />} />
      </RadioGroup>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`name`	`string`	Required	Configures name for this component.
`orientation`	`"horizontal" \| "vertical"`	—	Configures orientation for this component.

Complete TypeScript API

Import from @tavojs/ui/radio-group. Published exports: RadioGroup, RadioGroupProps.

`RadioGroupProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by RadioGroup.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by RadioGroup.
`id`	`string`	No	Inherited id attribute accepted by RadioGroup.
`role`	`string`	No	Inherited role attribute accepted by RadioGroup.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by RadioGroup.
`title`	`string`	No	Inherited title attribute accepted by RadioGroup.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by RadioGroup.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by RadioGroup.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by RadioGroup.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by RadioGroup.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by RadioGroup.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by RadioGroup.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by RadioGroup.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by RadioGroup.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by RadioGroup.
`name`	`string`	Yes	Configures name for this component.
`orientation`	`"horizontal" \| "vertical"`	No	Configures orientation for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Native input attributes target the owned form control; wrapper-specific props stay on the documented component root.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid RadioGroup when wrapping controls without labels or accessible names.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Uses `fieldset` semantics and propagates `name` to child radios when possible.

Uses `fieldset` semantics and propagates `name` to child radios when possible.

Component status

Contract	Current value
Maturity	stable
Category	forms
Component import	`@tavojs/ui/radio-group`
Explicit CSS import	`@tavojs/ui/css/radio-group`
Preview	Interactive preview available on this page