@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
31 lines (30 loc) • 1.01 kB
TypeScript
import { SxProps, Theme } from '@mui/material';
/**
* Properties of the CheckboxControl React component.
*/
export interface CheckboxControlProps {
/** The component id. */
id?: string;
/** A text label to be displayed. */
label: string;
/** The current check state. */
checked: boolean;
/**
* Callback that is called when the checked state has changed.
* @param checked The new checked state.
*/
onChange: (checked: boolean) => void;
/** Set to true to disable this control. */
disabled?: boolean;
/** The optional size, defaults to 'small'. */
size?: 'small' | 'medium';
/** Optional sx props. */
sx?: SxProps<Theme>;
}
/**
* Creates a checkbox UI control.
* @param props Component properties.
* @returns The CheckboxControl React component.
*/
declare function CheckboxControl({ id, label, checked, onChange, disabled, size, sx, }: CheckboxControlProps): import("react/jsx-runtime").JSX.Element;
export default CheckboxControl;