• /
  • Log in

Radio

When a user can choose only one of the options provided

The radio button state can be controlled through the checked property. If the checked prop is not set then the radio button will manage its own state.

You can listen to the radio button events through the onClick or the onChange props.

Usage

import { Radio } from 'nr1'

Examples

Props

checkedboolean

If true, the radio button is checked.

If defined, it turns the input into a controlled component.

classNamestring

Appends class names to the component.

Should be used only for positioning and spacing purposes.

descriptionstring

Message with instructions on how to fill the form field.

disabledboolean
DEFAULT
false

If true, the radio button is not available for interaction.

infostring

Additional information can be displayed in an info tooltip next to the Label.

invalidboolean|string

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.

labelstring

Text to display as label.

onChangefunction

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.

)
onClickfunction

Callback fired any time the radio button is clicked.

function (
event: React.MouseEvent //

Event source of the callback.

)
spacingTypeenum[]

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 of
Radio.SPACING_TYPE.EXTRA_LARGE,
Radio.SPACING_TYPE.LARGE,
Radio.SPACING_TYPE.MEDIUM,
Radio.SPACING_TYPE.NONE,
Radio.SPACING_TYPE.OMIT,
Radio.SPACING_TYPE.SMALL,
>
>
styleobject

Inline style for custom styling.

Should be used only for positioning and spacing purposes.

testIdstring

Adds a data-test-id attribute.

Use it to target the component in unit and e2e tests.

valuestring

The value of the component. Used by the <RadioGroup/> to identify the selected radio button.

Create issueEdit page
Copyright © 2021 New Relic Inc.