primevue-mirror/components/lib/inputtext/InputText.d.ts

124 lines
3.0 KiB
TypeScript
Raw Normal View History

2023-03-01 08:50:38 +00:00
/**
*
* InputText renders a text field to enter data.
*
* [Live Demo](https://www.primevue.org/inputtext/)
*
* @module inputtext
*
*/
2022-09-06 12:03:37 +00:00
import { InputHTMLAttributes } from 'vue';
2023-07-06 11:17:08 +00:00
import { ComponentHooks } from '../basecomponent';
import { ClassComponent, GlobalComponentConstructor, Nullable, PTOptions } from '../ts-helpers';
2022-09-06 12:03:37 +00:00
export declare type InputTextPassThroughOptionType = InputTextPassThroughAttributes | ((options: InputTextPassThroughMethodOptions) => InputTextPassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface InputTextPassThroughMethodOptions {
instance: any;
props: InputTextProps;
context: InputTextContext;
}
2023-05-05 12:53:35 +00:00
/**
* Custom passthrough(pt) options.
* @see {@link InputTextProps.pt}
*/
export interface InputTextPassThroughOptions {
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to the root's DOM element.
2023-05-05 12:53:35 +00:00
*/
root?: InputTextPassThroughOptionType;
2023-07-06 11:09:01 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to manage all lifecycle hooks
2023-07-06 11:09:01 +00:00
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
2023-05-05 12:53:35 +00:00
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface InputTextPassThroughAttributes {
[key: string]: any;
}
/**
* Defines current options in InputText component.
*/
export interface InputTextContext {
/**
* Current filled state of the component as a boolean.
* @defaultValue false
*/
filled: boolean;
/**
* Current disabled state of the component as a boolean.
* @defaultValue false
*/
disabled: boolean;
}
2023-03-01 08:50:38 +00:00
/**
* Defines valid properties in InputText component.
*/
2022-09-06 12:03:37 +00:00
export interface InputTextProps extends InputHTMLAttributes {
/**
* Value of the component.
*/
modelValue?: Nullable<string>;
2023-07-04 09:28:31 +00:00
/**
* Defines the size of the component.
*/
size?: 'small' | 'large' | undefined;
2023-05-05 12:53:35 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to DOM elements inside the component.
2023-05-05 12:53:35 +00:00
* @type {InputTextPassThroughOptions}
*/
pt?: PTOptions<InputTextPassThroughOptions>;
2023-05-24 11:23:36 +00:00
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
2022-09-06 12:03:37 +00:00
}
2023-03-01 08:50:38 +00:00
/**
* Defines valid slots in InputText component.
*/
2022-09-14 11:26:01 +00:00
export interface InputTextSlots {}
2022-09-06 12:03:37 +00:00
2023-03-01 08:50:38 +00:00
/**
* Defines valid emits in InputText component.
*/
export interface InputTextEmits {
2022-09-06 12:03:37 +00:00
/**
* Emitted when the value changes.
* @param {string} value - New value.
*/
2023-03-01 08:50:38 +00:00
'update:modelValue'(value: string | undefined): void;
}
2022-09-06 12:03:37 +00:00
2023-03-01 08:50:38 +00:00
/**
* **PrimeVue - InputText**
*
* _InputText renders a text field to enter data._
*
* [Live Demo](https://www.primevue.org/inputtext/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
2023-03-01 14:48:23 +00:00
declare class InputText extends ClassComponent<InputTextProps, InputTextSlots, InputTextEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
InputText: GlobalComponentConstructor<InputText>;
2022-09-06 12:03:37 +00:00
}
}
export default InputText;