@synergy-design-system/vue
Version:
Vue3 wrappers for the Synergy Design System
50 lines (47 loc) • 2.06 kB
TypeScript
import { default as SynCheckboxGroup } from '@synergy-design-system/components/components/checkbox-group/checkbox-group.component.js';
type __VLS_Props = {
/**
* The checkbox group's label.
* Required for proper accessibility.
If you need to display HTML, use the `label` slot instead.
*/
label?: SynCheckboxGroup['label'];
/**
* The checkbox groups's help text.
* If you need to display HTML, use the `help-text` slot instead.
*/
helpText?: SynCheckboxGroup['helpText'];
/**
* The checkbox group's size.
* This size will be applied to all child checkboxes.
*/
size?: SynCheckboxGroup['size'];
/**
* The layout of the checkbox group.
* This determines how the checkboxes are displayed.
- `horizontal`: Checkboxes are displayed in a row.
- `vertical`: Checkboxes are displayed in a column.
*/
layout?: SynCheckboxGroup['layout'];
/**
* By default, form controls are associated with the nearest containing `<form>` element.
This property allows you to specify the `id` of a `<form>` element to associate all of the slotted checkboxes and radios with.
Please note that this property does not associate the checkbox group itself with a form, only the slotted checkboxes and radios.
*/
form?: SynCheckboxGroup['form'];
};
declare var __VLS_9: {};
type __VLS_Slots = {} & {
default?: (props: typeof __VLS_9) => any;
};
declare const __VLS_base: import('vue').DefineComponent<__VLS_Props, {
nativeElement: import('vue').Ref<SynCheckboxGroup | undefined, SynCheckboxGroup | undefined>;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
declare const _default: typeof __VLS_export;
export default _default;
type __VLS_WithSlots<T, S> = T & {
new (): {
$slots: S;
};
};