Usage
import { Radio } from 'nr1'
Examples
Props
If true
, the radio button is checked.
If defined, it turns the input into a controlled component.
Appends class names to the component.
Should be used only for positioning and spacing purposes.
Message with instructions on how to fill the form field.
false
If true
, the radio button is not available for interaction.
Additional information can be displayed in an info tooltip next to the Label.
When true, sets the field in an invalid state, in order to notify the
user attention is needed over this particular field. This property
can be a boolean
field or a string
. When it is a string
, as
well as the invalid state being shown, the text will be shown below.
Text to display as label.
Callback fired any time the selected state of the radio button changes.
function (event: React.ChangeEvent, Event source of the callback.
value: any The value of the radio button.
)
Callback fired any time the radio button is clicked.
function (event: React.MouseEvent Event source of the callback.
)
Spacing property. Spacing is defined as a tuple of zero to four
values, which follow the same conventions as CSS properties like
margin
or padding
. To omit a value, use SPACING_TYPE.OMIT
.
<Array of<One ofRadio.SPACING_TYPE.EXTRA_LARGE,Radio.SPACING_TYPE.LARGE,Radio.SPACING_TYPE.MEDIUM,Radio.SPACING_TYPE.NONE,Radio.SPACING_TYPE.OMIT,Radio.SPACING_TYPE.SMALL,>
>
Inline style for custom styling.
Should be used only for positioning and spacing purposes.
Adds a data-test-id
attribute. Use it to target the component in unit and
E2E tests.
For a test id to be valid, prefix it with your nerdpack id, followed up by a dot.
For example, my-nerdpack.some-element
.
Note: You might not see data-test-id
attributes as they are removed
from the DOM, to debug them pass a e2e-test
query parameter to the URL.
The value of the component. Used by the <RadioGroup/>
to identify
the selected radio button.