@octopusdeploy/design-system-components/dist/src/components/Form/Primitives/CheckboxInput.d.ts

The design systems component library.

interface CheckboxInputProps {
    /**
     * The unique id of the checkbox input to associate the input with label and description.
     */
    id: string;
    /**
     * The name of the checkbox input, used when part of a group.
     */
    name?: string;
    /**
     * The value submitted when this checkbox is selected.
     */
    value: string;
    /**
     * Whether this checkbox is currently selected.
     */
    checked: boolean;
    /**
     * Called when the checkbox is toggled.
     */
    onChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
    /**
     * Disables the checkbox input.
     */
    disabled?: boolean;
    /**
     * Focuses the checkbox input on mount.
     */
    autoFocus?: boolean;
    /**
     * Renders the checkbox in the visual “indeterminate” (mixed) state.
     * Set `aria-checked="mixed"`.
     */
    isIndeterminate?: boolean;
    /**
     * Sets the aria-label attribute on the checkbox input.
     */
    ariaLabel?: string;
    /**
     * Sets the aria-describedby attribute on the checkbox input.
     */
    ariaDescribedBy?: string;
}
export declare const CheckboxInput: import("react").ForwardRefExoticComponent<CheckboxInputProps & import("react").RefAttributes<HTMLInputElement>>;
export declare const checkboxButtonSize = "1.25rem";
export {};