@react-md/form
Version:
This package is for creating all the different form input types.
25 lines (24 loc) • 1.04 kB
TypeScript
/// <reference types="react" />
import type { InputToggleProps } from "./InputToggle";
/** @remarks \@since 2.8.5 */
export interface IndeterminateCheckboxProps {
/**
* If the indeterminate prop is enabled, the this prop must be a
* space-delimited string of **all** the checkboxes that it controls.
*/
"aria-controls"?: string;
/**
* Boolean if the checkbox can have an indeterminate state. This is used when
* there is a checkbox group where a single checkbox and select/deselect all
* related checkboxes. This should be enabled when not all the related
* checkboxes have been checked.
*/
indeterminate?: boolean;
}
export interface CheckboxProps extends InputToggleProps, IndeterminateCheckboxProps {
}
/**
* The `Checkbox` component is just a wrapper for the `InputToggle` that
* defaults to reasonable defaults for a checkbox input.
*/
export declare const Checkbox: import("react").ForwardRefExoticComponent<CheckboxProps & import("react").RefAttributes<HTMLInputElement>>;