primevue 3.22.4 → 3.24.0

package/textarea/Textarea.d.ts

@@ -1,6 +1,19 @@
+/**
+ *
+ * Textarea is a multi-line text input element.
+ *
+ * [Live Demo](https://www.primevue.org/textarea/)
+ *
+ * @module textarea
+ *
+ */
 import { TextareaHTMLAttributes } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Defines valid properties in Textarea component. In addition to these, all properties of TextareaHTMLAttributes can be used in this component.
+ * @extends TextareaHTMLAttributes
+ */
 export interface TextareaProps extends TextareaHTMLAttributes {
     /**
      * Value of the component.
@@ -12,16 +25,34 @@ export interface TextareaProps extends TextareaHTMLAttributes {
     autoResize?: boolean | undefined;
 }
 
+/**
+ * Defines valid slots in Textarea component.
+ */
 export interface TextareaSlots {}
 
-export declare type TextareaEmits = {
+/**
+ * Defines valid emits in Textarea component.
+ */
+export interface TextareaEmits {
     /**
      * Emitted when the value changes.
      * @param {string} value - New value.
      */
     'update:modelValue': (value: string) => void;
-};
+}
 
+/**
+ * **PrimeVue - Textarea**
+ *
+ * _Textarea is a multi-line text input element._
+ *
+ * [Live Demo](https://www.primevue.org/textarea/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Textarea extends ClassComponent<TextareaProps, TextareaSlots, TextareaEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -30,13 +61,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Textarea is a multi-line text input element.
- *
- * Demos:
- *
- * - [Textarea](https://www.primefaces.org/primevue/textarea)
- *
- */
 export default Textarea;

package/tieredmenu/TieredMenu.d.ts

@@ -1,9 +1,19 @@
+/**
+ *
+ * TieredMenu displays submenus in nested overlays.
+ *
+ * [Live Demo](https://www.primevue.org/menu/)
+ *
+ * @module tieredmenu
+ *
+ */
 import { VNode } from 'vue';
 import { MenuItem } from '../menuitem';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type TieredMenuAppandToType = 'body' | 'self' | string | undefined | HTMLElement;
-
+/**
+ * Defines valid properties in TieredMenuMenu component.
+ */
 export interface TieredMenuProps {
     /**
      * An array of menuitems.
@@ -15,23 +25,22 @@ export interface TieredMenuProps {
     popup?: boolean | undefined;
     /**
      * A valid query selector or an HTMLElement to specify where the overlay gets attached.
-     * @see TieredMenuAppandToType
-     * Default value is 'body'.
+     * @defaultValue body
      */
-    appendTo?: TieredMenuAppandToType;
+    appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
     /**
      * Whether to automatically manage layering.
-     * Default value is true.
+     * @defaultValue true
      */
     autoZIndex?: boolean | undefined;
     /**
      * Base zIndex value to use in layering.
-     * Default value is 0.
+     * @defaultValue 0
      */
     baseZIndex?: number | undefined;
     /**
      * Whether to apply 'router-link-active-exact' class if route exactly matches the item path.
-     * Default value is true.
+     * @defaultValue true
      */
     exact?: boolean | undefined;
     /**
@@ -52,48 +61,66 @@ export interface TieredMenuProps {
     'aria-labelledby'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in TieredMenuMenu component.
+ */
 export interface TieredMenuSlots {
     /**
      * Custom content for each item.
      * @param {Object} scope - item slot's params.
      */
-    item: (scope: {
+    item(scope: {
         /**
          * Menuitem instance
          */
         item: MenuItem;
-    }) => VNode[];
+    }): VNode[];
 }
 
-export declare type TieredMenuEmits = {
+/**
+ * Defines valid emits in TieredMenuMenu component.
+ */
+export interface TieredMenuEmits {
     /**
      * Callback to invoke when the component receives focus.
      * @param {Event} event - Browser event.
      */
-    focus: (event: Event) => void;
+    focus(event: Event): void;
     /**
      * Callback to invoke when the component loses focus.
      * @param {Event} event - Browser event.
      */
-    blur: (event: Event) => void;
+    blur(event: Event): void;
     /**
      * Callback to invoke before the popup is shown.
      */
-    'before-show': () => void;
+    'before-show'(): void;
     /**
      * Callback to invoke before the popup is hidden.
      */
-    'before-hide': () => void;
+    'before-hide'(): void;
     /**
      * Callback to invoke when the popup is shown.
      */
-    show: () => void;
+    show(): void;
     /**
      * Callback to invoke when the popup is hidden.
      */
-    hide: () => void;
-};
+    hide(): void;
+}
 
+/**
+ * **PrimeVue - TieredMenu**
+ *
+ * _TieredMenu displays submenus in nested overlays._
+ *
+ * [Live Demo](https://www.primevue.org/tieredmenu/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class TieredMenu extends ClassComponent<TieredMenuProps, TieredMenuSlots, TieredMenuEmits> {
     /**
      * Toggles the visibility of the overlay.
@@ -123,17 +150,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * TieredMenu displays submenus in nested overlays.
- *
- * Helper API:
- *
- * - [MenuItem](https://www.primefaces.org/primevue/menumodel)
- *
- * Demos:
- *
- * - [TieredMenu](https://www.primefaces.org/primevue/tieredmenu)
- *
- */
 export default TieredMenu;

package/timeline/Timeline.d.ts

@@ -1,14 +1,17 @@
+/**
+ *
+ * Timeline visualizes a series of chained events.
+ *
+ * [Live Demo](https://primevue.org/timeline)
+ *
+ * @module timeline
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type TimelineVerticalAlignType = 'left' | 'right' | 'alternate' | undefined;
-
-type TimelineHorizontalAlignType = 'top' | 'bottom' | undefined;
-
-type TimelineAlignType = TimelineVerticalAlignType | TimelineHorizontalAlignType | undefined;
-
-type TimelineLayoutType = 'vertical' | 'horizontal' | undefined;
-
+/**
+ * Defines valid properties in Timeline component.
+ */
 export interface TimelineProps {
     /**
      * An array of events to display.
@@ -16,28 +19,29 @@ export interface TimelineProps {
     value?: any[] | undefined;
     /**
      * Position of the timeline bar relative to the content.
-     * @see TimelineAlignType
-     * Default value is 'left'.
+     * @defaultValue left
      */
-    align?: TimelineAlignType;
+    align?: 'left' | 'right' | 'alternate' | 'top' | 'bottom' | undefined;
     /**
      * Orientation of the timeline.
-     * @see TimelineLayoutType
-     * Default value is 'horizontal'.
+     * @defaultValue horizontal
      */
-    layout?: TimelineLayoutType;
+    layout?: 'vertical' | 'horizontal' | undefined;
     /**
      * Name of the field that uniquely identifies the a record in the data.
      */
     dataKey?: string | undefined;
 }
 
+/**
+ * Defines valid slots in Timeline component.
+ */
 export interface TimelineSlots {
     /**
      * Custom content template
      * @param {Object} scope - content slot's params.
      */
-    content: (scope: {
+    content(scope: {
         /**
          * Item data
          */
@@ -46,12 +50,12 @@ export interface TimelineSlots {
          * Index of item
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom opposite template.
      * @param {Object} scope - opposite slot's params.
      */
-    opposite: (scope: {
+    opposite(scope: {
         /**
          * Item data
          */
@@ -60,12 +64,12 @@ export interface TimelineSlots {
          * Index of item
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom marker template.
      * @param {Object} scope - marker slot's params.
      */
-    marker: (scope: {
+    marker(scope: {
         /**
          * Item data
          */
@@ -74,11 +78,11 @@ export interface TimelineSlots {
          * Index of item
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom connector template.
      */
-    connector: (scope: {
+    connector(scope: {
         /**
          * Item data
          */
@@ -87,11 +91,25 @@ export interface TimelineSlots {
          * Index of item
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
 }
 
-export declare type TimelineEmits = {};
+/**
+ * Defines valid emits in Timeline component.
+ */
+export interface TimelineEmits {}
 
+/**
+ * **PrimeVue - Timeline**
+ *
+ * _Timeline visualizes a series of chained events._
+ *
+ * [Live Demo](https://www.primevue.org/timeline/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class Timeline extends ClassComponent<TimelineProps, TimelineSlots, TimelineEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -100,13 +118,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Timeline visualizes a series of chained events.
- *
- * Demos:
- *
- * - [Timeline](https://www.primefaces.org/primevue/timeline)
- *
- */
 export default Timeline;

package/toast/Toast.d.ts

@@ -1,17 +1,24 @@
+/**
+ *
+ * Toast is used to display messages in an overlay.
+ *
+ * [Live Demo](https://www.primevue.org/toast/)
+ *
+ * @module toast
+ *
+ */
 import { ButtonHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type ToastPositionType = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'center' | undefined;
-
-type ToastMessageSeverityType = 'success' | 'info' | 'warn' | 'error' | undefined;
-
+/**
+ * Defines message options in Toast component.
+ */
 export interface ToastMessageOptions {
     /**
      * Severity level of the message.
-     * @see ToastMessageSeverityType
-     * Default value is 'info'.
+     * @defaultValue info
      */
-    severity?: any | undefined;
+    severity?: 'success' | 'info' | 'warn' | 'error' | undefined;
     /**
      * Summary content of the message.
      */
@@ -22,12 +29,12 @@ export interface ToastMessageOptions {
     detail?: any | undefined;
     /**
      * Whether the message can be closed manually using the close icon.
-     * Default value is true.
+     * @defaultValue true
      */
     closable?: boolean | undefined;
     /**
      * Delay in milliseconds to close the message automatically.
-     * Default value is 3000.
+     * @defaultValue 3000
      */
     life?: number | undefined;
     /**
@@ -44,6 +51,9 @@ export interface ToastMessageOptions {
     contentStyleClass?: any;
 }
 
+/**
+ * Defines breakpoints type in Toast component.
+ */
 export interface ToastBreakpointsType {
     /**
      * Breakpoint for responsive mode.
@@ -56,6 +66,9 @@ export interface ToastBreakpointsType {
     [key: string]: any;
 }
 
+/**
+ * Defines valid properties in Toast component.
+ */
 export interface ToastProps {
     /**
      * Unique identifier of a message group.
@@ -63,18 +76,17 @@ export interface ToastProps {
     group?: string | undefined;
     /**
      * Position of the toast in viewport.
-     * @see ToastPositionType
-     * Default value is 'top-right'.
+     * @defaultValue top-right
      */
-    position?: ToastPositionType;
+    position?: 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'center' | undefined;
     /**
      * Whether to automatically manage layering.
-     * Default value is true.
+     * @defaultValue true
      */
     autoZIndex?: boolean | undefined;
     /**
      * Base zIndex value to use in layering.
-     * Default value is 0.
+     * @defaultValue 0
      */
     baseZIndex?: number | undefined;
     /**
@@ -84,27 +96,27 @@ export interface ToastProps {
     breakpoints?: ToastBreakpointsType;
     /**
      * Icon to display in the toast close button.
-     * Default value is 'pi pi-times'.
+     * @defaultValue pi pi-times
      */
     closeIcon?: string | undefined;
     /**
      * Icon to display in the toast with info severity.
-     * Default value is 'pi pi-info-circle'.
+     * @defaultValue pi pi-info-circle
      */
     infoIcon?: string | undefined;
     /**
      * Icon to display in the toast with warn severity.
-     * Default value is 'pi pi-exclamation-triangle'.
+     * @defaultValue pi pi-exclamation-triangle
      */
     warnIcon?: string | undefined;
     /**
      * Icon to display in the toast with error severity.
-     * Default value is 'pi pi-times'.
+     * @defaultValue pi pi-times
      */
     errorIcon?: string | undefined;
     /**
      * Icon to display in the toast with success severity.
-     * Default value is 'pi pi-check'.
+     * @defaultValue pi pi-check
      */
     successIcon?: string | undefined;
     /**
@@ -113,21 +125,50 @@ export interface ToastProps {
     closeButtonProps?: ButtonHTMLAttributes | undefined;
 }
 
+/**
+ * Defines valid slot in Toast component.
+ */
 export interface ToastSlots {
     /**
      * Custom message template.
      * @param {Object} scope - message slot's params.
      */
-    message: (scope: {
+    message(scope: {
         /**
          * Message of the component
          */
         message: any;
-    }) => VNode[];
+    }): VNode[];
 }
 
-export declare type ToastEmits = {};
+/**
+ * Defines valid emits in Toast component.
+ */
+export interface ToastEmits {
+    /**
+     * Callback to invoke when the toast is closed.
+     * @param {ToastMessageOptions} message - Toast message.
+     */
+    close(message: ToastMessageOptions): void;
+    /**
+     * Callback to invoke when the toast's timeout is over.
+     * @param {ToastMessageOptions} message - Toast message.
+     */
+    'life-end'(message: ToastMessageOptions): void;
+}
 
+/**
+ * **PrimeVue - Toast**
+ *
+ * _Toast is used to display messages in an overlay._
+ *
+ * [Live Demo](https://www.primevue.org/toast/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Toast extends ClassComponent<ToastProps, ToastSlots, ToastEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -136,17 +177,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Toast is used to display messages in an overlay.
- *
- * Helper API:
- *
- * - ToastService
- *
- * Demos:
- *
- * - [Toast](https://www.primefaces.org/primevue/toast)
- *
- */
 export default Toast;

package/toast/Toast.vue

@@ -31,6 +31,7 @@ var messageIdx = 0;
 export default {
     name: 'Toast',
     inheritAttrs: false,
+    emits: ['close', 'life-end'],
     props: {
         group: {
             type: String,
@@ -111,17 +112,18 @@ export default {
 
             this.messages = [...this.messages, message];
         },
-        remove(message) {
+        remove(params) {
             let index = -1;
 
             for (let i = 0; i < this.messages.length; i++) {
-                if (this.messages[i] === message) {
+                if (this.messages[i] === params.message) {
                     index = i;
                     break;
                 }
             }
 
             this.messages.splice(index, 1);
+            this.$emit(params.type, { message: params.message });
         },
         onAdd(message) {
             if (this.group == message.group) {

package/toast/ToastMessage.vue

@@ -62,7 +62,7 @@ export default {
     mounted() {
         if (this.message.life) {
             this.closeTimeout = setTimeout(() => {
-                this.close();
+                this.close({ message: this.message, type: 'life-end' });
             }, this.message.life);
         }
     },
@@ -70,12 +70,12 @@ export default {
         this.clearCloseTimeout();
     },
     methods: {
-        close() {
-            this.$emit('close', this.message);
+        close(params) {
+            this.$emit('close', params);
         },
         onCloseClick() {
             this.clearCloseTimeout();
-            this.close();
+            this.close({ message: this.message, type: 'close' });
         },
         clearCloseTimeout() {
             if (this.closeTimeout) {

package/toast/toast.cjs.js

@@ -53,7 +53,7 @@ var script$1 = {
     mounted() {
         if (this.message.life) {
             this.closeTimeout = setTimeout(() => {
-                this.close();
+                this.close({ message: this.message, type: 'life-end' });
             }, this.message.life);
         }
     },
@@ -61,12 +61,12 @@ var script$1 = {
         this.clearCloseTimeout();
     },
     methods: {
-        close() {
-            this.$emit('close', this.message);
+        close(params) {
+            this.$emit('close', params);
         },
         onCloseClick() {
             this.clearCloseTimeout();
-            this.close();
+            this.close({ message: this.message, type: 'close' });
         },
         clearCloseTimeout() {
             if (this.closeTimeout) {
@@ -168,6 +168,7 @@ var messageIdx = 0;
 var script = {
     name: 'Toast',
     inheritAttrs: false,
+    emits: ['close', 'life-end'],
     props: {
         group: {
             type: String,
@@ -248,17 +249,18 @@ var script = {
 
             this.messages = [...this.messages, message];
         },
-        remove(message) {
+        remove(params) {
             let index = -1;
 
             for (let i = 0; i < this.messages.length; i++) {
-                if (this.messages[i] === message) {
+                if (this.messages[i] === params.message) {
                     index = i;
                     break;
                 }
             }
 
             this.messages.splice(index, 1);
+            this.$emit(params.type, { message: params.message });
         },
         onAdd(message) {
             if (this.group == message.group) {