Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

CheckboxProps

Props accepted by the host checkbox.

Import

import type { CheckboxProps } from "@dartwic/interface-sdk/ui";

Declaration

export interface CheckboxProps extends HostComponentProps {
    /** Controlled checked state. */
    checked?: boolean | "indeterminate";
    /** Initial uncontrolled checked state. */
    defaultChecked?: boolean;
    /** Called when the checked state changes. */
    onCheckedChange?: (checked: boolean | "indeterminate") => void;
    /** Disables interaction. */
    disabled?: boolean;
}

Members

Name	Type	Requirement	Description
`checked`	`boolean \| "indeterminate"`	Optional	Controlled checked state.
`defaultChecked`	`boolean`	Optional	Initial uncontrolled checked state.
`onCheckedChange`	`(checked: boolean \| "indeterminate") => void`	Optional	Called when the checked state changes.
`disabled`	`boolean`	Optional	Disables interaction.