Interface CheckboxControlProps

Properties of the CheckboxControl React component.

interface CheckboxControlProps {
    checked: boolean;
    disabled?: boolean;
    id?: string;
    label: string;
    onChange: (checked: boolean) => void;
    size?: "small" | "medium";
    sx?: SxProps<Theme>;
}

Properties

checked disabled? id? label onChange size? sx?

Properties

checked

checked: boolean

The current check state.

Optionaldisabled

disabled?: boolean

Set to true to disable this control.

Optionalid

id?: string

The component id.

label

label: string

A text label to be displayed.

onChange

onChange: (checked: boolean) => void

Callback that is called when the checked state has changed.

Type declaration

    • (checked: boolean): void

    • Parameters

      • checked: boolean

        The new checked state.

      Returns void

Optionalsize

size?: "small" | "medium"

The optional size, defaults to 'small'.

Optionalsx

sx?: SxProps<Theme>

Optional sx props.

Settings

Member Visibility

On This Page

Properties