InputMask InputSwitch d.ts updated

pull/3689/head
Bahadır Sofuoğlu 2023-03-01 15:40:56 +03:00
parent 98b96d0aef
commit bb87624e48
2 changed files with 76 additions and 32 deletions

View File

@ -1,5 +1,17 @@
/**
*
* InputMask groups a collection of contents in tabs.
*
* [Live Demo](https://www.primevue.org/inputmask/)
*
* @module inputmask
*
*/
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Defines valid properties in InputMask component.
*/
export interface InputMaskProps {
/**
* Value of the component.
@ -7,7 +19,7 @@ export interface InputMaskProps {
modelValue?: string | undefined;
/**
* Placeholder character in mask, default is underscore.
* Default value is '_'.
* @defaultValue _
*/
slotChar?: string | undefined;
/**
@ -16,35 +28,44 @@ export interface InputMaskProps {
mask?: string | undefined;
/**
* Clears the incomplete value on blur.
* Default value is true.
* @defaultValue true
*/
autoClear?: boolean | undefined;
/**
* Defines if model sets the raw unmasked value to bound value or the formatted mask value.
* @defaultValue false
*/
unmask?: boolean | undefined;
/**
* Whether the items are clickable or not.
* @defaultValue false
*/
readonly?: boolean | undefined;
}
export interface InputMaskSlots {}
export declare type InputMaskEmits = {
/**
* Defines valid emits in InputMask component.
*/
export interface InputMaskEmits {
/**
* Emitted when the value changes.
* @param {string} value - New value.
*/
'update:modelValue': (value: string) => void;
'update:modelValue'(value: string): void;
/**
* Callback to invoke when the component receives focus.
*/
focus: (event: Event) => void;
focus(event: Event): void;
/**
* Callback to invoke when the component loses focus.
*/
blur: (event: Event) => void;
blur(event: Event): void;
/**
* Callback to invoke when a key is pressed.
*/
keydown: (event: Event) => void;
keydown(event: Event): void;
/**
* Callback to invoke when a key that produces a character value is pressed down.
*/
@ -57,8 +78,20 @@ export declare type InputMaskEmits = {
* Callback to invoke when the mask is completed.
*/
complete: (event: Event) => void;
};
}
/**
* **PrimeVue - InputMask**
*
* _InputMask groups a collection of contents in tabs._
*
* [Live Demo](https://www.primevue.org/inputmask/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
declare class InputMask extends ClassComponent<InputMaskProps, InputMaskSlots, InputMaskEmits> {}
declare module '@vue/runtime-core' {
@ -67,13 +100,4 @@ declare module '@vue/runtime-core' {
}
}
/**
*
* InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.
*
* Demos:
*
* - [InputMask](https://www.primefaces.org/primevue/inputmask)
*
*/
export default InputMask;

View File

@ -1,6 +1,18 @@
/**
*
* InputSwitch groups a collection of contents in tabs.
*
* [Live Demo](https://www.primevue.org/inputswitch/)
*
* @module inputswitch
*
*/
import { InputHTMLAttributes } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Defines valid properties in InputSwitch component.
*/
export interface InputSwitchProps {
/**
* Specifies whether a inputswitch should be checked or not.
@ -8,10 +20,12 @@ export interface InputSwitchProps {
modelValue?: boolean | string | undefined;
/**
* Value in checked state.
* @defaultValue true
*/
trueValue?: any;
/**
* Value in unchecked state.
* @defaultValue false
*/
falseValue?: any;
/**
@ -42,29 +56,44 @@ export interface InputSwitchProps {
export interface InputSwitchSlots {}
export declare type InputSwitchEmits = {
/**
* Defines valid emits in InputSwitch component.
*/
export interface InputSwitchEmits {
/**
* Emitted when the value changes.
* @param {boolean} value - New value.
*/
'update:modelValue': (value: boolean) => void;
'update:modelValue'(value: boolean): void;
/**
* Callback to invoke on click.
* @param {Event} event - Browser event.
*/
click: (event: Event) => void;
click(event: Event): void;
/**
* Callback to invoke on value change.
* @param {Event} event - Browser event.
*/
change: (event: Event) => void;
change(event: Event): void;
/**
* Callback to invoke on value change.
* @param {boolean} value - New value.
*/
input: (value: boolean) => void;
};
input(value: boolean): void;
}
/**
* **PrimeVue - InputSwitch**
*
* _InputSwitch groups a collection of contents in tabs._
*
* [Live Demo](https://www.primevue.org/inputswitch/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
declare class InputSwitch extends ClassComponent<InputSwitchProps, InputSwitchSlots, InputSwitchEmits> {}
declare module '@vue/runtime-core' {
@ -73,13 +102,4 @@ declare module '@vue/runtime-core' {
}
}
/**
*
* InputSwitch is used to select a boolean value.
*
* Demos:
*
* - [InputSwitch](https://www.primefaces.org/primevue/inputswitch)
*
*/
export default InputSwitch;