Report an issue

Checkbox

Allow users to switch between checked, unchecked, and indeterminate states.

	<script lang="ts">
  import { Checkbox, Label } from "bits-ui";
  import Check from "phosphor-svelte/lib/Check";
  import Minus from "phosphor-svelte/lib/Minus";
</script>
 
<div class="flex items-center space-x-3">
  <Checkbox.Root
    id="terms"
    aria-labelledby="terms-label"
    class="peer inline-flex size-[25px] items-center justify-center rounded-md border border-muted bg-foreground transition-all duration-150 ease-in-out active:scale-98 data-[state=unchecked]:border-border-input data-[state=unchecked]:bg-background data-[state=unchecked]:hover:border-dark-40"
    name="hello"
  >
    {#snippet children({ checked })}
      <div class="inline-flex items-center justify-center text-background">
        {#if checked === true}
          <Check class="size-[15px]" weight="bold" />
        {:else if checked === "indeterminate"}
          <Minus class="size-[15px]" weight="bold" />
        {/if}
      </div>
    {/snippet}
  </Checkbox.Root>
  <Label.Root
    id="terms-label"
    for="terms"
    class="text-sm font-medium leading-none peer-disabled:cursor-not-allowed peer-disabled:opacity-70"
  >
    Accept terms and conditions
  </Label.Root>
</div>

Structure

	<script lang="ts">
	import { Checkbox } from "bits-ui";
</script>
 
<Checkbox.Root>
	<Checkbox.Indicator />
	<Checkbox.Input />
</Checkbox.Root>

API Reference

Checkbox.Root

The button component used to toggle the state of the checkbox.

Property Type Description
checked bindable prop
enum

The checkbox button's checked state. This can be a boolean or the string 'indeterminate', which would typically display a dash in the checkbox.

Default: false
onCheckedChange
function

A callback that is fired when the checkbox button's checked state changes.

Default: undefined
disabled
boolean

Whether or not the checkbox button is disabled. This prevents the user from interacting with it.

Default: false
required
boolean

Whether or not the checkbox is required.

Default: false
name
string

The name of the checkbox. If provided a hidden input will be render to use for form submission. If not provided, the hidden input will not be rendered.

Default: undefined
value
string

The value of the checkbox. This is what is submitted with the form when the checkbox is checked.

Default: undefined
ref bindable prop
HTMLButtonElement

The underlying DOM element being rendered. You can bind to this to get a reference to the element.

Default: undefined
children
Snippet

The children content to render.

Default: undefined
child
Snippet

Use render delegation to render your own element. See delegation docs for more information.

Default: undefined
Data Attribute Value Description
data-state
enum

The checkbox's state of checked, unchecked, or indeterminate.

data-disabled
''

Present when the checkbox is disabled.

data-checkbox-root
''

Present on the root element.

Examples

Controlled Usage

If you want to control or be aware of the checked state from outside the component, you can bind to the checked prop.

	<script lang="ts">
	import { Checkbox } from "bits-ui";
	let myChecked = false;
</script>
 
<p>Checked: {myChecked}</p>
<Checkbox.Root bind:checked={myChecked}>
	<Checkbox.Indicator />
	<Checkbox.Input />
</Checkbox.Root>