Checkbox

A checkbox allows the user to select an option.

View sourceView on npmReport an issueWAI-ARIA

Anatomy

Composed Components

A Checkbox uses the following components.

Icon

An icon component allow you to render a custom icon.

IconList

An IconList encapsulates a collection of icons.

Text

A text component is a primitive component matching Hopper's typography type scale.

Usage

No Label

A checkbox can be rendered without a label.

Checked

A checkbox can be checked.

Indeterminate

A checkbox can be indeterminate.

Disabled

A checkbox can be disabled.

Read-only

A checkbox can be read-only.

Invalid

A checkbox can be invalid.

Sizes

A checkbox can vary in size.

Icon

A checkbox can be rendered with an icon or an icon list.

Description

A checkbox can have a description to provide more information to the user.

Props

Checkbox

size?

A checkbox can vary in size.

Defaults to md.
style?

The inline style for the element. A function may be provided to compute the style based on component state.

children?

The children of the component. A function may be provided to alter the children based on component state.

validationBehavior?

Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.

Defaults to 'native'.
isIndeterminate?

Indeterminism is presentational only. The indeterminate visual representation remains regardless of user interaction.

value?

The value of the input element, used when submitting an HTML form. See MDN.

defaultSelected?

Whether the element should be selected (uncontrolled).

isSelected?

Whether the element should be selected (controlled).

onChange?

Handler that is called when the element's selection state changes.

isDisabled?

Whether the input is disabled.

isReadOnly?

Whether the input can be selected but not changed by the user.

isRequired?

Whether user input is required on the input before form submission.

isInvalid?

Whether the input value is invalid.

validate?

A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if validationBehavior="native". For realtime validation, use the isInvalid prop instead.

autoFocus?

Whether the element should receive focus on render.

id?

The element's unique identifier. See MDN.

name?

The name of the input element, used when submitting an HTML form. See MDN.

inputRef?

A ref for the HTML input element.

className?

The CSS className for the element. A function may be provided to compute the class based on component state.

CheckboxField

description?

The description of the checkbox field.

isDisabled?

Whether the checkbox field is disabled.

size?

A checkbox field can vary in size.

Defaults to md.
children?

The children of the component. A function may be provided to alter the children based on component state.

className?

The CSS className for the element. A function may be provided to compute the class based on component state.

style?

The inline style for the element. A function may be provided to compute the style based on component state.

Migration Notes

Coming from Orbiter, you should be aware of the following changes:

  • onChange signature has been changed (no event are passed).
  • onValueChange has been deleted, use onChange instead.
  • checked has been renamed to isSelected.
  • disabled has been renamed to isDisabled.
  • required has been renamed to isRequired.
  • indeterminate has been renamed to isIndeterminate.
  • defaultIndeterminate prop has been removed.
  • The Counter component is no longer allowed as a specialized slot.
  • reverse is not supported, use flex-direction or row-reverse instead.
  • validationState has been removed. Use isInvalid instead. There is no isValid.
  • Values are not auto-generated when missed.