@synergy-design-system/vue
Version:
Vue3 wrappers for the Synergy Design System
232 lines (231 loc) • 8.05 kB
TypeScript
import { SynBlurEvent, SynChangeEvent, SynFocusEvent, SynInputEvent, SynInvalidEvent, SynTextarea } 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?: SynTextarea["title"];
/**
* The name of the textarea, submitted as a name/value pair with form data.
*/
name?: SynTextarea["name"];
/**
* The current value of the textarea, submitted as a name/value pair with form data.
*/
value?: SynTextarea["value"];
/**
* The textarea's size.
*/
size?: SynTextarea["size"];
/**
* The textarea's label.
* If you need to display HTML, use the `label` slot instead.
*/
label?: SynTextarea["label"];
/**
* The textarea's help text.
* If you need to display HTML, use the `help-text` slot instead.
*/
helpText?: SynTextarea["helpText"];
/**
* Placeholder text to show as a hint when the input is empty.
*/
placeholder?: SynTextarea["placeholder"];
/**
* The number of rows to display by default.
*/
rows?: SynTextarea["rows"];
/**
* Controls how the textarea can be resized.
*/
resize?: SynTextarea["resize"];
/**
* Disables the textarea.
*/
disabled?: SynTextarea["disabled"];
/**
* Makes the textarea readonly.
*/
readonly?: SynTextarea["readonly"];
/**
* 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?: SynTextarea["form"];
/**
* Makes the textarea a required field.
*/
required?: SynTextarea["required"];
/**
* The minimum length of input that will be considered valid.
*/
minlength?: SynTextarea["minlength"];
/**
* The maximum length of input that will be considered valid.
*/
maxlength?: SynTextarea["maxlength"];
/**
* Controls whether and how text input is automatically capitalized as it is entered by the user.
*/
autocapitalize?: SynTextarea["autocapitalize"];
/**
* Indicates whether the browser's autocorrect feature is on or off.
*/
autocorrect?: SynTextarea["autocorrect"];
/**
* Specifies what permission the browser has to provide assistance in filling out form field values.
* Refer to
[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
*/
autocomplete?: SynTextarea["autocomplete"];
/**
* Indicates that the input should receive focus on page load.
*/
autofocus?: SynTextarea["autofocus"];
/**
* Used to customize the label or icon of the Enter key on virtual keyboards.
*/
enterkeyhint?: SynTextarea["enterkeyhint"];
/**
* Enables spell checking on the textarea.
*/
spellcheck?: SynTextarea["spellcheck"];
/**
* Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
keyboard on supportive devices.
*/
inputmode?: SynTextarea["inputmode"];
/**
* Support for two way data binding
*/
modelValue?: SynTextarea["value"];
}, {
nativeElement: import('vue').Ref<SynTextarea | undefined, SynTextarea | 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: string) => any;
}, string, import('vue').PublicProps, Readonly<{
title?: SynTextarea["title"];
/**
* The name of the textarea, submitted as a name/value pair with form data.
*/
name?: SynTextarea["name"];
/**
* The current value of the textarea, submitted as a name/value pair with form data.
*/
value?: SynTextarea["value"];
/**
* The textarea's size.
*/
size?: SynTextarea["size"];
/**
* The textarea's label.
* If you need to display HTML, use the `label` slot instead.
*/
label?: SynTextarea["label"];
/**
* The textarea's help text.
* If you need to display HTML, use the `help-text` slot instead.
*/
helpText?: SynTextarea["helpText"];
/**
* Placeholder text to show as a hint when the input is empty.
*/
placeholder?: SynTextarea["placeholder"];
/**
* The number of rows to display by default.
*/
rows?: SynTextarea["rows"];
/**
* Controls how the textarea can be resized.
*/
resize?: SynTextarea["resize"];
/**
* Disables the textarea.
*/
disabled?: SynTextarea["disabled"];
/**
* Makes the textarea readonly.
*/
readonly?: SynTextarea["readonly"];
/**
* 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?: SynTextarea["form"];
/**
* Makes the textarea a required field.
*/
required?: SynTextarea["required"];
/**
* The minimum length of input that will be considered valid.
*/
minlength?: SynTextarea["minlength"];
/**
* The maximum length of input that will be considered valid.
*/
maxlength?: SynTextarea["maxlength"];
/**
* Controls whether and how text input is automatically capitalized as it is entered by the user.
*/
autocapitalize?: SynTextarea["autocapitalize"];
/**
* Indicates whether the browser's autocorrect feature is on or off.
*/
autocorrect?: SynTextarea["autocorrect"];
/**
* Specifies what permission the browser has to provide assistance in filling out form field values.
* Refer to
[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
*/
autocomplete?: SynTextarea["autocomplete"];
/**
* Indicates that the input should receive focus on page load.
*/
autofocus?: SynTextarea["autofocus"];
/**
* Used to customize the label or icon of the Enter key on virtual keyboards.
*/
enterkeyhint?: SynTextarea["enterkeyhint"];
/**
* Enables spell checking on the textarea.
*/
spellcheck?: SynTextarea["spellcheck"];
/**
* Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
keyboard on supportive devices.
*/
inputmode?: SynTextarea["inputmode"];
/**
* Support for two way data binding
*/
modelValue?: SynTextarea["value"];
}> & 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: string) => any) | undefined;
}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
nativeElement: unknown;
}, any>, {
default?(_: {}): any;
}>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S;
};
};