@unicity/design-system
Version:
A comprehensive React component library built on Material-UI with advanced theming capabilities including neumorphism design support
50 lines • 1.32 kB
TypeScript
import React from 'react';
import { CheckboxProps as MuiCheckboxProps } from '@mui/material';
export interface CheckboxProps extends Omit<MuiCheckboxProps, 'onChange'> {
/**
* The label for the checkbox
*/
label?: string;
/**
* Whether the checkbox is checked
*/
checked?: boolean;
/**
* Whether the checkbox is indeterminate
*/
indeterminate?: boolean;
/**
* Callback fired when the checkbox is toggled
*/
onChange?: (checked: boolean, event: React.ChangeEvent<HTMLInputElement>) => void;
/**
* Whether the checkbox is disabled
*/
disabled?: boolean;
/**
* Whether the field has an error
*/
error?: boolean;
/**
* Helper text to display below the checkbox
*/
helperText?: string;
/**
* The size of the checkbox
*/
size?: 'small' | 'medium';
/**
* The color of the checkbox
*/
color?: 'primary' | 'secondary' | 'success' | 'warning' | 'error' | 'info';
/**
* Whether the checkbox is required
*/
required?: boolean;
/**
* Position of the label relative to the checkbox
*/
labelPlacement?: 'start' | 'end' | 'top' | 'bottom';
}
export declare const Checkbox: React.FC<CheckboxProps>;
//# sourceMappingURL=Checkbox.d.ts.map