{/*
* _____ _
*|_ _|_ _____ _ __ | |_ _ _
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
* | | \ V V / __/ | | | |_| |_| | DO NOT EDIT - changes will be overwritten
* |_| \_/\_/ \___|_| |_|\__|\__, | Generated by: npx nx generate:ui twenty-docs
* |___/
*
* This file is generated from the documentation data in packages/twenty-ui/generated.
* To update it, edit the component prop types or design tokens in twenty-ui and run:
* npx nx generate:ui twenty-docs
*/}
Whether the checkbox is currently ticked.
To render an uncontrolled checkbox, use the `defaultChecked` prop instead.
CSS class applied to the element, or a function that
returns a class based on the component's state.
Color used while the checkbox is checked or indeterminate.
Whether the checkbox is initially ticked.
To render a controlled checkbox, use the `checked` prop instead.
Whether the component should ignore user interaction.
Identifies the form that owns the hidden input.
Useful when the checkbox is rendered outside the form.
Adds padding around the box and a hover background. Disable it for a
compact checkbox inside another interactive element.
The id of the input element.
Whether the checkbox is in a mixed state: neither ticked, nor unticked.
A ref to access the hidden `` element.
Identifies the field when a form is submitted.
Whether the component renders a native `
Event handler called when the checkbox is ticked or unticked.
Whether the checkbox controls a group of child checkboxes.
Must be used in a [Checkbox Group](https://base-ui.com/react/components/checkbox-group).
Whether the user should be unable to tick or untick the checkbox.
Allows you to replace the component's HTML element
with a different tag, or compose it with another component.
Accepts a `ReactElement` or a function that returns the element to render.
Whether the user must tick the checkbox before submitting a form.
Corner shape of the box.
Visual size of the checkbox.
Style applied to the element, or a function that
returns a style object based on the component's state.
The value submitted with the form when the checkbox is unchecked.
By default, unchecked checkboxes do not submit any value, matching native checkbox behavior.
The checkbox's value. Identifies it within a [Checkbox Group](https://base-ui.com/react/components/checkbox-group), falling back to `name` when omitted.
When submitting a form, a checked box submits `value`; with no `value`, it submits the native "on".
Visual style of the box: filled, outlined, or tinted.