@patternfly/react-core
Version:
This library provides a set of common React components for use with the PatternFly reference implementation.
34 lines • 1.79 kB
TypeScript
/// <reference types="react" />
import { CheckboxProps } from '../Checkbox';
export interface DataListCheckProps extends Omit<CheckboxProps, 'ref' | 'id'> {
/** Id of the DataList checkbox. */
id?: string;
/** Additional classes added to the DataList item checkbox */
className?: string;
/** Flag to show if the DataList checkbox selection is valid or invalid */
isValid?: boolean;
/** Flag to show if the DataList checkbox is disabled */
isDisabled?: boolean;
/** Flag to show if the DataList checkbox is checked when it is controlled by React state. Both isChecked and checked are valid,
* but only use one.
* To make the DataList checkbox uncontrolled, instead use the defaultChecked prop, but do not use both.
*/
isChecked?: boolean;
/** Flag to show if the DataList checkbox is checked when it is controlled by React state. Both isChecked and checked are valid,
* but only use one.
* To make the DataList checkbox uncontrolled, instead use the defaultChecked prop, but do not use both.
*/
checked?: boolean;
/** Flag to set default value of DataList checkbox when it is uncontrolled by React state.
* To make the DataList checkbox controlled, instead use the isChecked prop, but do not use both.
*/
defaultChecked?: boolean;
/** A callback for when the DataList checkbox selection changes */
onChange?: (event: React.FormEvent<HTMLInputElement>, checked: boolean) => void;
/** Aria-labelledby of the DataList checkbox */
'aria-labelledby': string;
/** Flag to indicate if other controls are used in the DataListItem */
otherControls?: boolean;
}
export declare const DataListCheck: React.FunctionComponent<DataListCheckProps>;
//# sourceMappingURL=DataListCheck.d.ts.map