Components
API Reference

API Reference

Radio inputs allow users to select one option from a list. It should be used inside a RadioGroup component.

<RadioGroup label="Radio group">
  <Radio value="1">Option 1</Radio>
  <Radio value="2">Option 2</Radio>
  <Radio value="3">Option 3</Radio>
</RadioGroup>

Parameters

props

  • Type: @vtex/shoreline-components.RadioProps & @types/react.React.RefAttributes<typescript.HTMLInputElement>

Props

error (optional)

Wether is disabled

  • Type: boolean

  • Default: false

value

The value of the radio

  • Type: string

View source (opens in a new tab)