Checkbox

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

import {
  Checkbox,
  CheckboxDescription,
  CheckboxIcon,
  CheckboxInput,
  CheckboxLabel,
  CheckboxText,
  CheckboxTextWrapper,
} from "@adaptui/react-tailwind";

💡

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

Usage

<Checkbox>Label text</Checkbox>

<Checkbox>Label text</Checkbox>

Disabled

Checkbox sizes

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

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="inline-flex flex-col space-y-2">
      <Checkbox size="sm" defaultValue={false} />
      <Checkbox size="md" defaultValue={false} />
      <Checkbox size="lg" defaultValue={false} />
    </div>
  );
};

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="inline-flex flex-col space-y-2">
      <Checkbox size="sm" defaultValue={false} />
      <Checkbox size="md" defaultValue={false} />
      <Checkbox size="lg" defaultValue={false} />
    </div>
  );
};

Checkbox Uncontrolled

Uncontrolled checkbox can be used with defaultState prop.

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="inline-flex flex-col space-y-2">
      <Checkbox size="md" defaultValue={true} />
      <Checkbox size="md" defaultValue={false} />
      <Checkbox size="md" defaultValue="indeterminate" />
    </div>
  );
};

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="inline-flex flex-col space-y-2">
      <Checkbox size="md" defaultValue={true} />
      <Checkbox size="md" defaultValue={false} />
      <Checkbox size="md" defaultValue="indeterminate" />
    </div>
  );
};

Checkbox UI states

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="inline-flex w-72 flex-col space-y-2">
      <Checkbox size="md" defaultState={false} label="Checkbox" />
      <Checkbox
        size="md"
        defaultValue={false}
        label="Multilined label Checkbox, just for demonstration"
      />
      <Checkbox
        size="md"
        defaultValue={false}
        label="Checkbox"
        description="Used when the checkbox is selected and will use its value for the form submission."
      />
    </div>
  );
};

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="inline-flex w-72 flex-col space-y-2">
      <Checkbox size="md" defaultState={false} label="Checkbox" />
      <Checkbox
        size="md"
        defaultValue={false}
        label="Multilined label Checkbox, just for demonstration"
      />
      <Checkbox
        size="md"
        defaultValue={false}
        label="Checkbox"
        description="Used when the checkbox is selected and will use its value for the form submission."
      />
    </div>
  );
};

Checkbox Disabled states

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="flex w-72 flex-col space-y-2">
      <Checkbox size="md" disabled defaultState={false} />
      <Checkbox size="md" disabled defaultState={false} label="Checkboxs" />
      <Checkbox
        size="md"
        disabled
        defaultValue={false}
        label="Used when the checkbox is selected and will use its value for the form submission."
      />
      <Checkbox
        size="md"
        disabled
        defaultValue={false}
        label="Checkboxs"
        description="Used when the checkbox is selected and will use its value for the form submission."
      />
    </div>
  );
};

import { Checkbox } from "@adaptui/react-tailwind";

export const App = props => {
  return (
    <div className="flex w-72 flex-col space-y-2">
      <Checkbox size="md" disabled defaultState={false} />
      <Checkbox size="md" disabled defaultState={false} label="Checkboxs" />
      <Checkbox
        size="md"
        disabled
        defaultValue={false}
        label="Used when the checkbox is selected and will use its value for the form submission."
      />
      <Checkbox
        size="md"
        disabled
        defaultValue={false}
        label="Checkboxs"
        description="Used when the checkbox is selected and will use its value for the form submission."
      />
    </div>
  );
};

API Reference

Prop	Type	Default
`size`	`union`	`md`
`disabled`	`boolean`	`false`
`isChecked`	`boolean`	`false`
`isUnchecked`	`boolean`	`false`
`isIndeterminate`	`boolean`	`false`
`label`	`React.ReactNode`	-
`description`	`React.ReactNode`	-
`icon`	`React.ReactNode`	-

Last updated on July 27, 2022

Checkbox

Imports#

Usage#

Checkbox sizes#

Checkbox Uncontrolled#

Checkbox UI states#

Checkbox Disabled states#

API Reference#

Imports