Checkbox Example

Displays a checkbox. Useful in a form.

How to use this checkbox

Props

NameTypeDefaultDescription
asChildbooleanfalseChange the default rendered element for the one passed as a child, merging their props and behavior.
defaultCheckedboolean | "indeterminate"-The checked state of the checkbox when it is initially rendered. Use when you do not need to control its checked state.
checkedboolean | "indeterminate"-The controlled checked state of the checkbox. Must be used in conjunction with onCheckedChange.
onCheckedChange(checked: boolean | 'indeterminate') => void-Event handler called when the checked state of the checkbox changes.
disabledboolean-When true, prevents the user from interacting with the checkbox.
requiredboolean-When true, indicates that the user must check the checkbox before the owning form can be submitted.
namestring-The name of the checkbox. Submitted with its owning form as part of a name/value pair.
valuestring-The value given as data when submitted with a name.

Playground

Import from filigran-ui :

Import {Checkbox} from 'filigran-ui'

<div className={tw('flex items-center space-x-2')}>
  <Checkbox id="terms" />
  <label
    htmlFor="terms"
    className={tw('text-sm font-medium leading-none peer-disabled:cursor-not-allowed peer-disabled:opacity-70')}
  >
    Accept terms and conditions
  </label>
</div>