Axinom Mosaic Libraries
    Preparing search index...

    Interface CheckboxProps

    interface CheckboxProps {
        autoFocus?: boolean;
        className?: string;
        confirmationConfig?: ConfirmationConfig;
        confirmationMode?: "None" | "Advanced";
        disabled?: boolean;
        error?: string;
        id?: string;
        inlineMode?: boolean;
        label?: string;
        name: string;
        onBlur?: (event: ChangeEvent<HTMLInputElement>) => void;
        onChange?: (value: boolean) => void;
        onFocus?: (event: ChangeEvent<HTMLInputElement>) => void;
        tooltipContent?: ReactNode;
        value?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoFocus? className? confirmationConfig? confirmationMode? disabled? error? id? inlineMode? label? name onBlur? onChange? onFocus? tooltipContent? value?

    Properties

    autoFocus?: boolean

    Whether or not the control should start focused (default: false)

    className?: string

    CSS Class name for additional styles

    confirmationConfig?: ConfirmationConfig

    Optional text overrides for the confirmation pop up.

    confirmationMode?: "None" | "Advanced"

    If set to 'Advanced', action will require confirmation via a confirmation pop up. (default: 'None')

    disabled?: boolean

    Whether or not the control is disabled (default: false)

    error?: string

    If set, indicates the control has an error and will display this prop as the error message

    id?: string

    Form control id

    inlineMode?: boolean

    Hide options not needed in the “inline” scenario

    label?: string

    Form control label

    name: string

    Name of form control, required and must be unique from other form control names. This name should match the the name of the object corresponding to this control.

    onBlur?: (event: ChangeEvent<HTMLInputElement>) => void

    Raised when the element has been selected

    onChange?: (value: boolean) => void
    onFocus?: (event: ChangeEvent<HTMLInputElement>) => void

    Raised when the element has been de-selected

    tooltipContent?: ReactNode

    A tooltip of additional information

    value?: boolean

    Current value the form control has

    Settings

    Member Visibility

    On This Page

    Properties