Checkbox Field
A single checkbox laid out as a field row with label, description, and hint or error text.
Show codeHide code
Installation
import { CheckboxField } from "@makeplane/propel/components/checkbox-field";Usage
import { CheckboxField } from "@makeplane/propel/components/checkbox-field";
export default function BasicDemo() {
return (
<CheckboxField
name="emailUpdates"
value="enabled"
label="Email updates"
size="lg"
description="Send a message when the deployment status changes."
hint="You can change this later."
defaultChecked
/>
);
}Examples
Sizes
size scales the label, description, and helper text; the checkbox box keeps one size.
Show codeHide code
Invalid
Setting error marks the field invalid, recoloring the box border to danger and showing the error text in place of the hint.
Show codeHide code
Controlled
Show codeHide code
API Reference
CheckboxField
Ready-to-use single checkbox field with label, description, and helper/error text.