Radio Props — Vortex Design System

Radio

Radio is a form control that lets people choose a single option from a set, such as a delivery method or billing interval.

Import

import { Radio } from '@vortexlabs/vortex';
import type { RadioProps } from '@vortexlabs/vortex';

Allied components

Radio.Group props
Prop	Type	Default
`name`	`string`	No default value
`children`	`React.ReactNode`	No default value
`value`	`union`	No default value
`defaultValue`	`string`	No default value
`onChange`	`callback`	No default value
`ariaLabel`	`string`	No default value
`disabled`	`boolean`	No default value
`error`	`boolean`	No default value
`id`	`string`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value

Radio.Item props
Prop	Type	Default
`value`	`string`	No default value
`children`	`React.ReactNode`	No default value
`helperText`	`React.ReactNode`	No default value
`ariaLabel`	`string`	No default value
`disabled`	`boolean`	No default value
`error`	`boolean`	No default value
`size`	`union`	`md`
`gap`	`number`	`3`
`stretched`	`boolean`	No default value
`onChange`	`callback`	No default value
`onFocus`	`callback`	No default value
`onBlur`	`callback`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value
`inputAttributes`	`object`	No default value
`ref`	`ref`	No default value

Radio.GroupLabel props
Prop	Type	Default
`children`	`React.ReactNode`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value

Radio.GroupDescription props
Prop	Type	Default
`children`	`React.ReactNode`	No default value
`className`	`union`	No default value
`attributes`	`object`	No default value