@rws-aoa/react-library
Version:
RWS AOA Design System
26 lines • 815 B
TypeScript
import { CheckboxProps as MUICheckboxProps } from '@mui/material';
export interface AoaCheckboxProps extends Omit<MUICheckboxProps, 'checkedIcon' | 'icon'> {
/**
* Whether this checkbox is checked
*/
readonly checked: boolean;
/**
* Data-qa tag for E2E test purposes
*/
readonly 'data-qa'?: string;
/**
* The label that is shown after the checkbox
*/
readonly label: string;
}
/**
* Constructs a checkbox using pre-defined Rijks styling
*
* @param props - Props to pass to the checkbox
* @example
* ```jsx
* <AoaCheckbox label="Demo checkbox" checked={true} onChange={handleChange} />} />
* ```
*/
export declare function AoaCheckbox({ label, ...props }: AoaCheckboxProps): import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=Checkbox.d.ts.map