Function RadioGroup

Parameters

• props: {
      ariaLabel?: string;
      disabled?: boolean;
      options: readonly RadioGroupOptionType<ValueType>[];
      orientation?: "horizontal" | "vertical";
      value: ValueType;
      onValueChange(value: ValueType): void;
  }

  • OptionalariaLabel?: string

    Provide an accessible name for the group as a whole. Radio groups rarely have a visible caption, so setting this is recommended — screen readers announce it when focus enters the group.

    Example

    `Operating system`
    Copy

  • Optionaldisabled?: boolean

    Default

    false
    Copy

  • options: readonly RadioGroupOptionType<ValueType>[]

    Available options that can be selected.

  • Optionalorientation?: "horizontal" | "vertical"

    Default

    'vertical'
    Copy

  • value: ValueType

    The controlled value of the radio group. Should be used in conjunction with onValueChange.

  • onValueChange: function

    • onValueChange(value: ValueType): void

      Called when the user selects an option.

      Parameters

      • value: ValueType

      Returns void