primevue-mirror/components/textarea/Textarea.d.ts

66 lines
1.5 KiB
TypeScript
Raw Normal View History

2023-03-01 11:14:38 +00:00
/**
*
* Textarea is a multi-line text input element.
*
* [Live Demo](https://www.primevue.org/textarea/)
*
* @module textarea
*
*/
2022-09-06 12:03:37 +00:00
import { TextareaHTMLAttributes } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-03-01 11:14:38 +00:00
/**
* Defines valid properties in Textarea component. In addition to these, all properties of TextareaHTMLAttributes can be used in this component.
* @extends TextareaHTMLAttributes
*/
2022-09-06 12:03:37 +00:00
export interface TextareaProps extends TextareaHTMLAttributes {
/**
* Value of the component.
*/
modelValue?: string | undefined;
/**
* When present, height of textarea changes as being typed.
2023-03-10 14:00:58 +00:00
* @defaultValue false
2022-09-06 12:03:37 +00:00
*/
autoResize?: boolean | undefined;
}
2023-03-01 11:14:38 +00:00
/**
* Defines valid slots in Textarea component.
*/
2022-09-14 11:26:01 +00:00
export interface TextareaSlots {}
2022-09-06 12:03:37 +00:00
2023-03-01 11:14:38 +00:00
/**
* Defines valid emits in Textarea component.
*/
export interface TextareaEmits {
2022-09-06 12:03:37 +00:00
/**
* Emitted when the value changes.
* @param {string} value - New value.
*/
'update:modelValue': (value: string) => void;
2023-03-01 11:14:38 +00:00
}
2022-09-06 12:03:37 +00:00
2023-03-01 11:14:38 +00:00
/**
* **PrimeVue - Textarea**
*
* _Textarea is a multi-line text input element._
*
* [Live Demo](https://www.primevue.org/textarea/)
* --- ---
2023-03-03 10:55:20 +00:00
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
2023-03-01 11:14:38 +00:00
*
* @group Component
*
*/
2022-09-14 11:26:01 +00:00
declare class Textarea extends ClassComponent<TextareaProps, TextareaSlots, TextareaEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
Textarea: GlobalComponentConstructor<Textarea>;
2022-09-06 12:03:37 +00:00
}
}
export default Textarea;