DocsComponentsCheckbox

Checkbox

Checkboxes allow users to select multiple items from a list of individual items, or to mark one individual item as selected.

Usage

Disabled

Sizes

Colors

Radius

Indeterminate

You can modify some settings to make the checkbox Indeterminate, overriding its appearance and maintaining it until set to false, regardless of user interaction.

Line Through

Custom Check Icon

Slots

  • checkbox: Checkbox wrapper, it handles alignment, placement, and general appearance.
  • icon-wrapper: The icon wrapper which wraps the icon.
  • icon: Icon within the checkbox, controlling size, visibility, and changes when checked required when using custom icon.
  • label: The text associated with the checkbox.

Custom Styles

You can customize the Checkbox component by passing custom Tailwind CSS classes to the component slots.

Data Attributes

Checkbox has the following attributes on the base element:

  • data-invalid: When the checkbox is invalid.
  • data-disabled: When the checkbox is disabled.
  • data-required: Whether user checkbox is required on the checkbox before form submission.
  • data-line-through: Whether the label should be crossed out.
  • data-disable-animation: Whether to disable the animation.

Accessibility

  • Built with a native HTML <input> element.
  • Full support for browser features like form autofill.
  • Keyboard focus management and cross browser normalization.
  • Keyboard event support for Tab and Space keys.
  • Labeling support for assistive technology.
  • Indeterminate state support.

Checkbox Properties

PropertyTypeDescriptionDefault
sizesm | md | lgThe size of the checkbox.sm
colorforeground | default | primary | secondary | success | warning | dangerThe color of the checkbox.default
radiusnone | sm | md | lg | fullThe radius of the checkbox.md
data-required"true" | "false"Whether user checkbox is required on the checkbox before form submission.false
data-line-through"true" | "false"Whether the label should be crossed out.false
data-disabled"true" | "false"Whether the checkbox is disabled.false
data-disable-animation"true" | "false"Whether the animation should be disabled.false