• Log inFree account

Checkbox

Usage

import { Checkbox } from 'nr1'

Examples

Props

checkedboolean
classNamestring

Appends class names to the component.

Should be used only for positioning and spacing purposes.

defaultCheckedboolean

If true, the initial state of the checkbox is checked.

Useful when you don't want to use a controlled component.

descriptionstring

Message with instructions on how to fill the form field.

disabledboolean

If true, the checkbox is not available for interaction.

indeterminateboolean

If true, the checkbox is in an indeterminate state.

If both the checked and indeterminate prop are provided then the indeterminate prop will prevail.

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 checkbox changes.

function (
event: React.ChangeEvent

The event source of the callback. You can access the new value with event.target.checked.

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

valuestring

The value of the component. This goes into the inner checkbox input, not the component itself, and is returned as part of the onChange event target element.

Copyright © 2022 New Relic Inc.