Kvaser CanKing GUI Extensions SDK - v7.5.1
    Preparing search index...

    Interface CheckboxControlProps

    Properties of the CheckboxControl React component.

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

    Properties

    checked disabled? disableTypography? id? label onChange size? sx? typography?

    Properties

    checked: boolean

    The current check state.

    disabled?: boolean

    Set to true to disable this control.

    disableTypography?: boolean

    If true, the label is rendered as it is passed without an additional typography node.

    id?: string

    The component id.

    label: string

    A text label to be displayed.

    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

    size?: "small" | "medium"

    The optional size, defaults to 'small'.

    sx?: SxProps<Theme>

    Optional sx props.

    typography?: TypographyProps

    Props applied to the Typography wrapper of the passed label. This is unused if disableTypography is true.

    Settings

    Member Visibility

    On This Page

    Properties