@workday/canvas-kit-react/dist/commonjs/checkbox/lib/CheckboxInput.d.ts

The parent module that contains all Workday Canvas Kit React components

import * as React from 'react';
import { ErrorType } from '@workday/canvas-kit-react/common';
import { CSProps } from '@workday/canvas-kit-styling';
export interface CheckboxProps extends CSProps {
    /**
     * If true, set the Checkbox to the checked state.
     * @default false
     */
    checked?: boolean;
    /**
     * If true, set the Checkbox to the disabled state.
     * @default false
     */
    disabled?: boolean;
    /**
     * The type of error associated with the Checkbox (if applicable).
     */
    error?: ErrorType;
    /**
     * The HTML `id` of the underlying checkbox input element. This is required if `label` is defined as a non-empty string.
     * @default {useUniqueId}
     */
    id?: string;
    /**
     * If true, set the Checkbox to an indeterminate state. Use this on a Checkbox with nested child Checkboxes to denote that some (but not all) child Checkboxes are checked.
     * @default false
     */
    indeterminate?: boolean;
    /**
     * The text of the Checkbox label.
     * @default ''
     */
    label?: string;
    /**
     * The function called when the Checkbox state changes.
     */
    onChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
    /**
     * The value of the Checkbox.
     */
    value?: string;
    /**
     * The variant for the checkbox
     */
    variant?: 'inverse' | undefined;
}
export declare const CheckboxInput: import("@workday/canvas-kit-react/common").ElementComponent<"input", CheckboxProps>;
//# sourceMappingURL=CheckboxInput.d.ts.map