@synergy-design-system/vue/dist/components/SynVueCheckbox.vue.d.ts

Vue3 wrappers for the Synergy Design System

import { SynBlurEvent, SynChangeEvent, SynFocusEvent, SynInputEvent, SynInvalidEvent, SynCheckbox } from '@synergy-design-system/components';
export type { SynBlurEvent } from '@synergy-design-system/components';
export type { SynChangeEvent } from '@synergy-design-system/components';
export type { SynFocusEvent } from '@synergy-design-system/components';
export type { SynInputEvent } from '@synergy-design-system/components';
export type { SynInvalidEvent } from '@synergy-design-system/components';
declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<{
    title?: SynCheckbox["title"];
    /**
     * The name of the checkbox, submitted as a name/value pair with form data.
     */
    name?: SynCheckbox["name"];
    /**
     * The current value of the checkbox, submitted as a name/value pair with form data.
     */
    value?: SynCheckbox["value"];
    /**
     * The checkbox's size.
     */
    size?: SynCheckbox["size"];
    /**
     * Disables the checkbox.
     */
    disabled?: SynCheckbox["disabled"];
    /**
     * Draws the checkbox in a checked state.
     */
    checked?: SynCheckbox["checked"];
    /**
  * Draws the checkbox in an indeterminate state.
  * This is usually applied to checkboxes that represents a "select
  all/none" behavior when associated checkboxes have a mix of checked and unchecked states.
   */
    indeterminate?: SynCheckbox["indeterminate"];
    /**
  * By default, form controls are associated with the nearest containing `<form>` element.
  * This attribute allows you
  to place the form control outside of a form and associate it with the form that has this `id`.
  * The form must be in
  the same document or shadow root for this to work.
   */
    form?: SynCheckbox["form"];
    /**
     * Makes the checkbox a required field.
     */
    required?: SynCheckbox["required"];
    /**
     * The checkbox's help text.
     * If you need to display HTML, use the `help-text` slot instead.
     */
    helpText?: SynCheckbox["helpText"];
    /**
     * Support for two way data binding
     */
    modelValue?: SynCheckbox["checked"];
}, {
    nativeElement: import('vue').Ref<SynCheckbox | undefined, SynCheckbox | undefined>;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
    "syn-blur": (e: SynBlurEvent) => any;
    "syn-focus": (e: SynFocusEvent) => any;
    "syn-invalid": (e: SynInvalidEvent) => any;
    "syn-change": (e: SynChangeEvent) => any;
    "syn-input": (e: SynInputEvent) => any;
    "update:modelValue": (newValue: boolean) => any;
}, string, import('vue').PublicProps, Readonly<{
    title?: SynCheckbox["title"];
    /**
     * The name of the checkbox, submitted as a name/value pair with form data.
     */
    name?: SynCheckbox["name"];
    /**
     * The current value of the checkbox, submitted as a name/value pair with form data.
     */
    value?: SynCheckbox["value"];
    /**
     * The checkbox's size.
     */
    size?: SynCheckbox["size"];
    /**
     * Disables the checkbox.
     */
    disabled?: SynCheckbox["disabled"];
    /**
     * Draws the checkbox in a checked state.
     */
    checked?: SynCheckbox["checked"];
    /**
  * Draws the checkbox in an indeterminate state.
  * This is usually applied to checkboxes that represents a "select
  all/none" behavior when associated checkboxes have a mix of checked and unchecked states.
   */
    indeterminate?: SynCheckbox["indeterminate"];
    /**
  * By default, form controls are associated with the nearest containing `<form>` element.
  * This attribute allows you
  to place the form control outside of a form and associate it with the form that has this `id`.
  * The form must be in
  the same document or shadow root for this to work.
   */
    form?: SynCheckbox["form"];
    /**
     * Makes the checkbox a required field.
     */
    required?: SynCheckbox["required"];
    /**
     * The checkbox's help text.
     * If you need to display HTML, use the `help-text` slot instead.
     */
    helpText?: SynCheckbox["helpText"];
    /**
     * Support for two way data binding
     */
    modelValue?: SynCheckbox["checked"];
}> & Readonly<{
    "onSyn-blur"?: ((e: SynBlurEvent) => any) | undefined;
    "onSyn-focus"?: ((e: SynFocusEvent) => any) | undefined;
    "onSyn-invalid"?: ((e: SynInvalidEvent) => any) | undefined;
    "onSyn-change"?: ((e: SynChangeEvent) => any) | undefined;
    "onSyn-input"?: ((e: SynInputEvent) => any) | undefined;
    "onUpdate:modelValue"?: ((newValue: boolean) => any) | undefined;
}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
    nativeElement: unknown;
}, any>, {
    default?(_: {}): any;
}>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
    new (): {
        $slots: S;
    };
};