@opencloud-eu/design-system
Version:
OpenCloud Design System is used to design OpenCloud UI components
49 lines (48 loc) • 1.55 kB
TypeScript
export interface Props {
/**
* @docs The label of the checkbox element.
*/
label: string;
/**
* @docs Determines if the checkbox is disabled.
*
*/
disabled?: boolean;
/**
* @docs The element ID of the checkbox.
*/
id?: string;
/**
* @docs Determines if the label is hidden visually. Note that the label will still be read by screen readers.
* @default false
*/
labelHidden?: boolean;
/**
* @docs The option value of the checkbox.
*/
option?: unknown;
/**
* @docs The size of the checkbox.
* @default medium
*/
size?: 'small' | 'medium' | 'large';
}
export interface Emits {
/**
* @docs Emitted when the checkbox has been clicked.
*/
(e: 'click', event: MouseEvent | KeyboardEvent): void;
}
type __VLS_Props = Props;
type __VLS_PublicProps = {
modelValue?: boolean | unknown[];
} & __VLS_Props;
declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
"update:modelValue": (value: boolean | unknown[]) => any;
} & {
click: (event: MouseEvent | KeyboardEvent) => any;
}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
onClick?: (event: MouseEvent | KeyboardEvent) => any;
"onUpdate:modelValue"?: (value: boolean | unknown[]) => any;
}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLSpanElement>;
export default _default;