Inplace .d.ts updated
parent
095f600cc8
commit
42439a8379
|
@ -1,22 +1,37 @@
|
||||||
import { HTMLAttributes, ButtonHTMLAttributes, VNode } from 'vue';
|
/**
|
||||||
|
*
|
||||||
|
* Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.
|
||||||
|
*
|
||||||
|
* [Live Demo](https://www.primevue.org/inplace)
|
||||||
|
*
|
||||||
|
* @module inplace
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
import { ButtonHTMLAttributes, HTMLAttributes, VNode } from 'vue';
|
||||||
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defines valid properties in Inplace component.
|
||||||
|
*/
|
||||||
export interface InplaceProps {
|
export interface InplaceProps {
|
||||||
/**
|
/**
|
||||||
* Displays a button to switch back to display mode.
|
* Displays a button to switch back to display mode.
|
||||||
|
* @defaultValue false
|
||||||
*/
|
*/
|
||||||
closable?: boolean | undefined;
|
closable?: boolean | undefined;
|
||||||
/**
|
/**
|
||||||
* Whether the content is displayed or not.
|
* Whether the content is displayed or not.
|
||||||
|
* @defaultValue false
|
||||||
*/
|
*/
|
||||||
active?: boolean | undefined;
|
active?: boolean | undefined;
|
||||||
/**
|
/**
|
||||||
* When present, it specifies that the element should be disabled.
|
* When present, it specifies that the element should be disabled.
|
||||||
|
* @defaultValue false
|
||||||
*/
|
*/
|
||||||
disabled?: boolean | undefined;
|
disabled?: boolean | undefined;
|
||||||
/**
|
/**
|
||||||
* Icon to display in the close button.
|
* Icon to display in the close button.
|
||||||
* Default value is 'pi pi-times'.
|
* @defaultValue pi pi-times
|
||||||
*/
|
*/
|
||||||
closeIcon?: string | undefined;
|
closeIcon?: string | undefined;
|
||||||
/**
|
/**
|
||||||
|
@ -29,35 +44,52 @@ export interface InplaceProps {
|
||||||
closeButtonProps?: ButtonHTMLAttributes | undefined;
|
closeButtonProps?: ButtonHTMLAttributes | undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defines valid slots in Inplace component.
|
||||||
|
*/
|
||||||
export interface InplaceSlots {
|
export interface InplaceSlots {
|
||||||
/**
|
/**
|
||||||
* Custom display template.
|
* Custom display template.
|
||||||
*/
|
*/
|
||||||
display: () => VNode[];
|
display(): VNode[];
|
||||||
/**
|
/**
|
||||||
* Custom content template.
|
* Custom content template.
|
||||||
*/
|
*/
|
||||||
content: () => VNode[];
|
content(): VNode[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export declare type InplaceEmits = {
|
/**
|
||||||
|
* Defines valid emits in Inplace component.
|
||||||
|
*/
|
||||||
|
export interface InplaceEmits {
|
||||||
/**
|
/**
|
||||||
* Emitted when the active changes.
|
* Emitted when the active changes.
|
||||||
* @param {boolean} value - New value.
|
* @param {boolean} value - New value.
|
||||||
*/
|
*/
|
||||||
'update:active': (value: boolean) => void;
|
'update:active'(value: boolean): void;
|
||||||
/**
|
/**
|
||||||
* Callback to invoke when inplace is opened.
|
* Callback to invoke when inplace is opened.
|
||||||
* @param {Event} event - Browser event.
|
* @param {Event} event - Browser event.
|
||||||
*/
|
*/
|
||||||
open: (event: Event) => void;
|
open(event: Event): void;
|
||||||
/**
|
/**
|
||||||
* Callback to invoke when inplace is closed.
|
* Callback to invoke when inplace is closed.
|
||||||
* @param {Event} event - Browser event.
|
* @param {Event} event - Browser event.
|
||||||
*/
|
*/
|
||||||
close: (event: Event) => void;
|
close(event: Event): void;
|
||||||
};
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* **PrimeVue - Inplace**
|
||||||
|
*
|
||||||
|
* _Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content._
|
||||||
|
*
|
||||||
|
* [Live Demo](https://www.primevue.org/inplace/)
|
||||||
|
* --- ---
|
||||||
|
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
|
||||||
|
*
|
||||||
|
* @group Component
|
||||||
|
*/
|
||||||
declare class Inplace extends ClassComponent<InplaceProps, InplaceSlots, InplaceEmits> {}
|
declare class Inplace extends ClassComponent<InplaceProps, InplaceSlots, InplaceEmits> {}
|
||||||
|
|
||||||
declare module '@vue/runtime-core' {
|
declare module '@vue/runtime-core' {
|
||||||
|
@ -66,13 +98,4 @@ declare module '@vue/runtime-core' {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
* Inplace provides an easy to do editing and display at the same time where clicking the output displays the actual content.
|
|
||||||
*
|
|
||||||
* Demos:
|
|
||||||
*
|
|
||||||
* - [Inplace](https://www.primefaces.org/primevue/inplace)
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
export default Inplace;
|
export default Inplace;
|
||||||
|
|
Loading…
Reference in New Issue