Switch

Usage

import { Switch } from 'nr1'

Examples

Props

ariaLabelstring

Provide a descriptive label for this control, e.g. "Switch view".

checkedboolean

Determines the checked state of the switch, where true corresponds to the switch appearing to be switched "on", and a false value to the switch appearing to be "off".

When checked is defined, the Switch component will behave like a controlled component.

classNamestring

Appends class names to the component. Should be used only for positioning and spacing purposes.

defaultCheckedboolean

DEFAULT

false

Sets the default checked value for the switch when operating as an uncontrolled component.

ie. Where the checked prop is not already stipulated.

descriptionstring

Message with instructions on how to fill the form field.

disabledboolean

DEFAULT

false

Determines whether the user can interact with the switch, or if it should be rendered in a disabled state.

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

Associate a text label to provide users a brief title or explanation for the setting controlled by the switch. The label will be positioned on the left side of the switch.

loadingboolean

DEFAULT

false

To indicate whether an action is in progress, especially in the case that it takes more than 1 second to complete, you should display the loading state. The switch is not interactive while loading.

If the action associated to the loading state fails, the checked property should be set back to its previous value.

onChangefunction

Callback fired any time the user toggles the switch. The current checked state can be evaluated in the callback via event.target.checked.

function (event: React.ChangeEvent 
)

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 ofSwitch.SPACING_TYPE.EXTRA_LARGE,
Switch.SPACING_TYPE.LARGE,
Switch.SPACING_TYPE.MEDIUM,
Switch.SPACING_TYPE.NONE,
Switch.SPACING_TYPE.OMIT,
Switch.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.

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.