Radio Group

Installation

Copy editable source into an initialized application:

pnpm dlx @simurgh-ui/cli add radio-group

For package consumption, import from the component subpath and load its optional recipe CSS:

React

import {
  RadioGroup,
  RadioGroupItem,
} from '@simurgh-ui/react/radio-group';
import '@simurgh-ui/styles/radio-group.css';

Vue

import {
  RadioGroup,
  RadioGroupItem,
} from '@simurgh-ui/vue/radio-group';
import '@simurgh-ui/styles/radio-group.css';

Angular

import {
  RadioGroupComponent,
  RadioGroupItemDirective,
} from '@simurgh-ui/angular/radio-group';
import '@simurgh-ui/styles/radio-group.css';

Omit the component stylesheet for fully headless styling. CLI-copied components use the local path written to simurgh.json and the copied application styles instead of these package imports.

Purpose

Radio Group allows one value from a visible set. Arrow keys move and select, Home/End jump to the boundaries, horizontal movement follows RTL direction, and the selected value participates in native form submission.

Default presentation: headless

No default visual treatment is applied. The public component supplies behavior and semantics; consumers provide layout and appearance.

Basic usage

Live component Radio Group ◆

Choose a plan

BasicPro

Anatomy

The public component parts are listed in API surface below. Use only the parts needed by the example; compound components depend on their documented parent/child nesting.

State model

Controlled state remains the application’s source of truth and must be updated from every change event. Uncontrolled state reads its default only when the component mounts. Do not pass both forms of the same state at once.

Framework	Exact state contract and reset behavior
React	Controlled: value + onValueChange. Uncontrolled: defaultValue. Reset controlled state by assigning the initial value; reset uncontrolled state by changing a React key.
Vue	Controlled: v-model (modelValue + update:modelValue). Uncontrolled: defaultValue. Reset the model ref to its initial value; reset uncontrolled state with a changed Vue :key.
Angular	Controlled two-way binding: [(value)] (value + valueChange). Angular exposes no separate default input; initialize and reset the bound class field explicitly.

React

const initialValue = '';
const [value, setValue] = useState(initialValue);
const [resetKey, setResetKey] = useState(0);

<RadioGroup value={value} onValueChange={setValue}>…</RadioGroup>
<button onClick={() => setValue(initialValue)}>Reset controlled</button>
<RadioGroup key={resetKey} defaultValue={initialValue}>…</RadioGroup>
<button onClick={() => setResetKey((key) => key + 1)}>Reset uncontrolled</button>

Vue

<script setup lang="ts">
import { ref } from 'vue';
const initial = '';
const state = ref(initial);
const resetKey = ref(0);
</script>

<RadioGroup v-model="state">…</RadioGroup>
<button @click="state = initial">Reset controlled</button>
<RadioGroup :key="resetKey" :defaultValue="initial">…</RadioGroup>
<button @click="resetKey++">Reset uncontrolled</button>

Angular

initial = '';
value = this.initial;
reset() { this.value = this.initial; }

<simurgh-radio-group [(value)]="value">…</simurgh-radio-group>
<button type="button" (click)="reset()">Reset</button>

Examples

React

<RadioGroup name="plan" defaultValue="basic"><RadioGroupItem value="basic">Basic</RadioGroupItem><RadioGroupItem value="pro">Pro</RadioGroupItem></RadioGroup>

Vue

<RadioGroup v-model="plan" name="plan"><RadioGroupItem value="basic">Basic</RadioGroupItem><RadioGroupItem value="pro">Pro</RadioGroupItem></RadioGroup>

Angular

<simurgh-radio-group name="plan" [(value)]="plan"><button simurghRadio="basic">Basic</button><button simurghRadio="pro">Pro</button></simurgh-radio-group>

Keyboard interactions

These keys describe behavior implemented by the adapters. Native Tab, Enter, and Space behavior still applies to descendant links, buttons, and form controls unless the component overrides it.

Concern / keys	Behavior
Focus entry and exit (Tab / Shift+Tab)	Tab enters at the checked radio, or the first enabled radio when none is checked.
Navigation and activation	Arrow keys move focus and selection; Home/End move to first/last.
Escape	Not handled by the component.
RTL differences	Horizontal previous/next arrows reverse in RTL.
Typeahead	Not supported.

Accessibility

Preserve the documented composition and accessible names when wrapping or restyling this component. See accessibility and RTL guidance for keyboard, focus, labeling, and directionality requirements.

API surface

• React exports: RadioGroup, RadioGroupItem
• Vue exports: RadioGroup, RadioGroupItem
• Angular exports: RadioGroupComponent, RadioGroupItemDirective

Import these public symbols from the component subpath shown in Installation. Framework-specific props, events, slots, directives, methods, defaults, and native-attribute behavior belong in the API tables on this page; use the linked source only to verify the current implementation.

React API reference

React

An inherited-attributes entry means the component accepts the complete named React native interface, including its event handlers and ARIA and data attributes. Remaining attributes are forwarded to the rendered element unless the component behavior described on this page overrides them.

RadioGroup

Inherited attributes: HTMLAttributes<HTMLDivElement>.

Prop	Type	Default / requirement
children	ReactNode	undefined
defaultValue	string | (readonly string[] & string)	undefined
direction	Direction	undefined
disabled	boolean	undefined
name	string	undefined
onValueChange	(value: string) => void	undefined
required	boolean	undefined
value	string	undefined

RadioGroupItem

Inherited attributes: ButtonHTMLAttributes<HTMLButtonElement>.

Prop	Type	Default / requirement
children	ReactNode	undefined
value	string	Required

Vue API reference

Vue

Boolean props without explicit defaults use Vue’s false default. Undeclared attributes follow the fallthrough behavior stated for each component.

RadioGroup

Vue attribute fallthrough is enabled for the rendered root.

Prop	Type	Default / requirement
modelValue	string	''
defaultValue	string	''
name	string	undefined
required	boolean	false
disabled	boolean	false
direction	Direction	'ltr'

Event	Payload
update:modelValue	string

Slots: default.

Exposed methods: none.

RadioGroupItem

Vue attribute fallthrough is enabled for the rendered root.

Prop	Type	Default / requirement
value	string	Required
disabled	boolean	false

No emitted events.

Slots: default.

Exposed methods: none.

Angular API reference

Angular

Inputs and outputs use their public template names. Public methods are callable through a template reference or ViewChild. Native attributes apply to the documented template root or directive host; they are not automatically forwarded through component hosts.

RadioGroupComponent

Component selector: simurgh-radio-group. The template’s first native element is div.

Input	Type	Default / requirement
value	string	''
name	string	undefined
required	boolean	false
disabled	boolean	false
direction	Direction	'ltr'

Output	Payload
valueChange	string

Content projection: default.

Public method
select(value: string): void
navigate(event: KeyboardEvent): void

RadioGroupItemDirective

Attribute directive selector: [simurghRadio]; behavior applies to its host element.

Input	Type	Default / requirement
simurghRadio	string	''
disabled	boolean	false

No outputs.

Content projection: none.

Public method
select(): void

Composition contract

Follow the framework example as a structural contract. Root components own shared state; parts that consume that state must stay under the root (or be attached to projected descendants in Angular). Parts described as conditional are optional until their corresponding interaction or semantic region is used. Do not render a state-consuming part by itself.

Framework	Required parent/child relationship	Conditional parts	Supporting types
React	Render RadioGroup as the ancestor. Nest the listed parts inside that root so they can read its shared state/context.	RadioGroupItem are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	None.
Vue	Render RadioGroup as the ancestor. Nest the listed parts inside that root so they can read its shared state/context.	RadioGroupItem are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	None.
Angular	Create RadioGroupComponent first. Attach listed directives to elements inside its projected content; nested component parts must remain inside it.	RadioGroupItemDirective are conditional parts: include only those needed by the documented anatomy. A trigger/control and its matching content/item are required when that interaction is used.	None.

Accessible names, descriptions, and form labels remain required whenever the component’s purpose cannot otherwise be determined, even when the corresponding visual part is optional.

Framework parity and differences

The adapters target the same user-visible behavior and accessibility contract. Their public shapes follow each framework’s conventions and are not expected to be symbol-for-symbol identical.

Concern	Contract
Public composition	All adapters export 2 public symbols, with framework-idiomatic names.
State and change events	React uses controlled/default props and callbacks for value; Vue uses v-model; Angular uses [(value)].
Children and content	React uses children; Vue uses the slots listed above; Angular uses the documented content projection selectors.
Native attributes	React forwards the named native interface; Vue follows the stated fallthrough rule; Angular attributes apply to the component host unless an input, directive, or documented native root consumes them.
Imperative access	React has no forwarded ref; Vue exposes no methods; Angular exposes the listed class methods through a template reference or ViewChild.

These differences are intentional adapter design. Behavioral or accessibility differences not stated on this page are parity defects rather than supported variations.

Form integration

Use name="contactMethod" to serialize the current value under the documented field name. The examples initialize the field, keep its value application-owned, forward disabled and required, render an accessible error, and read the browser submission payload. This component has no public invalid prop; announce validation errors next to the labeled control and use native validity where available.

React

const initial = 'email';
const [value, setValue] = useState(initial);
const [errors, setErrors] = useState<Record<string, string>>({});

<form onSubmit={(event) => {
  event.preventDefault();
  const data = new FormData(event.currentTarget);
  // Submit data.get('contactMethod').
}}>
  <RadioGroup name="contactMethod" value={value} onValueChange={setValue}
    required disabled={isDisabled} />
  {errors.contactMethod && <p role="alert">{errors.contactMethod}</p>}
  <button type="submit">Submit</button>
</form>

Vue

<script setup lang="ts">
import { reactive, ref } from 'vue';
const initial = 'email';
const value = ref(initial);
const errors = reactive<Record<string, string>>({});
function submit(event: Event) {
  const data = new FormData(event.currentTarget as HTMLFormElement);
  // Submit data.get('contactMethod').
}
</script>

<form @submit.prevent="submit">
  <RadioGroup v-model="value" name="contactMethod" required :disabled="isDisabled"></RadioGroup>
  <p v-if="errors.contactMethod" role="alert">{{ errors.contactMethod }}</p>
  <button type="submit">Submit</button>
</form>

Angular

initial = 'email';
value = this.initial;
errors: Record<string, string> = {};
submit(form: HTMLFormElement) {
  const data = new FormData(form);
  // Submit data.get('contactMethod').
}

<form #form (submit)="submit(form); $event.preventDefault()">
  <simurgh-radio-group [(value)]="value" name="contactMethod" required [disabled]="isDisabled"></simurgh-radio-group>
  <p *ngIf="errors.contactMethod" role="alert">{{ errors.contactMethod }}</p>
  <button type="submit">Submit</button>
</form>

For Angular reactive or template-driven forms, bridge the documented value/valueChange pair to your form control. The component does not implement ControlValueAccessor; update disabled and validation state from the Angular form explicitly.

Supported states

The table distinguishes component behavior from application-owned presentation. “Not supported” means there is no public state contract for that adapter; do not invent one with an undocumented attribute. Keep status and error messages accessible when they are rendered outside the component.

State	React	Vue	Angular
Loading	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Empty	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Invalid	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Read-only	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.
Disabled	Supported with disabled={true} on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.	Supported with :disabled="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.	Supported with [disabled]="true" on the documented control or interactive part; its interaction is blocked. Disabled form controls are omitted from submission.
Error	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.	Not supported by this component API; handle this state in surrounding application UI.

Styling contract

Styling contract

The selectors below are used by the published component recipe or emitted consistently by an adapter. Treat these as the supported styling surface. Element order, anonymous wrappers, and undocumented descendants are implementation details and should not be targeted.

Surface	Stable hooks
Recipe classes	No component-specific recipe class; this stylesheet currently imports shared tokens only.
Stable DOM parts	No named data-slot parts are emitted; target the forwarded root class or attributes documented in the API.
Stable data attributes	No documented data-* hook.
ARIA/state selectors used by the recipe	No ARIA state selector is used by this recipe.
CSS custom properties consumed	No component-specific token consumption beyond the shared token import.

Prefer a semantic token override for theme-wide changes. Use the listed class or part selectors for a component-scoped override. When omitting recipe CSS, preserve state attributes and ARIA semantics even if your replacement styles use different selectors.

Customization

Load the optional component stylesheet for the default recipe, override semantic tokens for broad theme changes, or omit the recipe CSS for headless styling. See theming and styling hooks for import order, selectors, dark mode, RTL, and reduced-motion guidance.

Last verified on 2026-08-13 against Simurgh registry 0.1.1.

Related components

• Review the shared accessibility and RTL guidance and theming and styling hooks.
• Use the component chooser and component overview to compare related primitives.
• Inspect the registry manifest and framework source for React, Vue, or Angular.