Skip to content
Docs
Components
Forms
Checkbox

Checkbox

The Checkbox is used in forms when a user needs to select multiple values from several options. Checkbox composes reakit's checkbox component.

Imports

import {
  Checkbox,
  CheckboxDescription,
  CheckboxIcon,
  CheckboxInput,
  CheckboxLabel,
  useCheckboxProps,
  useCheckboxState,
  CheckboxText,
} from "@renderlesskit/react-tailwind";
💡

A complex component that supports customization as per the composition guide.

Usage

Checkbox sizes

Sizes can be set using the size prop. The default size is md. The available sizes are: sm md lg

Checkbox Uncontrolled

Uncontrolled checkbox can be used with defaultState prop.

Checkbox UI states

Checkbox Disabled states

API Reference

Prop

Type

Default

sizeunionmd
disabledbooleanfalse
isCheckedbooleanfalse
isUncheckedbooleanfalse
isIndeterminatebooleanfalse
labelReact.ReactNode-
descriptionReact.ReactNode-
iconReact.ReactNode-