primevue 3.22.4 → 3.24.0

package/confirmationoptions/ConfirmationOptions.d.ts

@@ -1,5 +1,14 @@
-type ConfirmationPositionType = 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined;
+/**
+ *
+ * [Live Demo](https://www.primevue.org/confirmdialog/)
+ *
+ * @module confirmationoptions
+ *
+ */
 
+/**
+ * Confirmation Service options.
+ */
 export interface ConfirmationOptions {
     /**
      * Element to align the overlay.
@@ -18,11 +27,10 @@ export interface ConfirmationOptions {
      */
     group?: string | undefined;
     /**
-     * Position of the dialog, options are 'center', 'top', 'bottom', 'left', 'right', 'topleft', 'topright', 'bottomleft' or 'bottomright'.
-     * @see ConfirmationPositionType
-     * Default value is 'center'.
+     * Position of the dialog.
+     * @defaultValue center
      */
-    position?: ConfirmationPositionType;
+    position?: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright' | undefined;
     /**
      * Icon to display next to the message.
      */
@@ -33,12 +41,13 @@ export interface ConfirmationOptions {
     blockScroll?: boolean | undefined;
     /**
      * Callback to execute when action is confirmed.
+     * @todo Next release should be able to change
      */
     accept?: () => void;
     /**
      * Callback to execute when action is rejected.
      */
-    reject?: () => void;
+    reject?(): void;
     /**
      * Callback to execute when dialog is hidden.
      */

package/confirmationservice/ConfirmationService.d.ts

@@ -1,9 +1,20 @@
+/**
+ *
+ * [Live Demo](https://www.primevue.org/confirmdialog/)
+ *
+ * @module confirmationservice-useconfirm
+ *
+ */
 import { Plugin } from 'vue';
 import { ConfirmationOptions } from '../confirmationoptions';
 
 declare const plugin: Plugin;
 export default plugin;
 
+/**
+ * Confirmation Service methods.
+ * @group Model
+ */
 export interface ConfirmationServiceMethods {
     /**
      * Displays the dialog using the confirmation object options.

package/confirmdialog/ConfirmDialog.d.ts

@@ -1,7 +1,19 @@
+/**
+ *
+ * ConfirmDialog uses a Dialog UI with confirmDialog method or <ConfirmDialog> tag.
+ *
+ * [Live Demo](https://www.primevue.org/confirmdialog)
+ *
+ * @module confirmdialog
+ *
+ */
 import { VNode } from 'vue';
-import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 import { ConfirmationOptions } from '../confirmationoptions';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Breakpoint metadata.
+ */
 export interface ConfirmDialogBreakpoints {
     /**
      * Breakpoint for responsive mode.
@@ -21,6 +33,9 @@ export interface ConfirmDialogBreakpoints {
     [key: string]: string;
 }
 
+/**
+ * Defines valid properties in ConfirmDialog component.
+ */
 export interface ConfirmDialogProps {
     /**
      * Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.
@@ -33,16 +48,33 @@ export interface ConfirmDialogProps {
     breakpoints?: ConfirmDialogBreakpoints;
 }
 
+/**
+ * Defines valid slots in ConfirmDialog component.
+ */
 export interface ConfirmDialogSlots {
     /**
      * Custom message template.
      * @param {Object} scope - message slot's params.
      */
-    message: (scope: { message: ConfirmationOptions }) => VNode[];
+    message(scope: { message: ConfirmationOptions }): VNode[];
 }
 
-export declare type ConfirmDialogEmits = {};
+/**
+ * Defines valid emits in ConfirmDialog component.
+ */
+export interface ConfirmDialogEmits {}
 
+/**
+ * **PrimeVue - ConfirmDialog**
+ *
+ * _ConfirmDialog uses a Dialog UI with confirmDialog method or <ConfirmDialog> tag._
+ *
+ * [Live Demo](https://www.primevue.org/confirmdialog/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class ConfirmDialog extends ClassComponent<ConfirmDialogProps, ConfirmDialogSlots, ConfirmDialogEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -51,18 +83,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API.
- *
- * Helper API:
- *
- * - Confirmation API
- * - ConfirmationService
- *
- * Demos:
- *
- * - [ConfirmDialog](https://www.primefaces.org/primevue/confirmdialog)
- *
- */
 export default ConfirmDialog;

package/confirmpopup/ConfirmPopup.d.ts

@@ -1,7 +1,19 @@
+/**
+ *
+ * ConfirmPopup displays a confirmation overlay displayed relatively to its target.
+ *
+ * [Live Demo](https://www.primevue.org/confirmpopup)
+ *
+ * @module confirmpopup
+ *
+ */
 import { VNode } from 'vue';
-import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 import { ConfirmationOptions } from '../confirmationoptions';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Defines valid properties in ConfirmPopup component.
+ */
 export interface ConfirmPopupProps {
     /**
      * Optional key to match the key of the confirmation, useful to target a specific confirm dialog instance.
@@ -9,16 +21,33 @@ export interface ConfirmPopupProps {
     group?: string;
 }
 
+/**
+ * Defines valid slots in ConfirmPopup component.
+ */
 export interface ConfirmPopupSlots {
     /**
      * Custom message template.
      * @param {Object} scope - message slot's params.
      */
-    message: (scope: { message: ConfirmationOptions }) => VNode[];
+    message(scope: { message: ConfirmationOptions }): VNode[];
 }
 
-export declare type ConfirmPopupEmits = {};
+/**
+ * Defines valid emits in ConfirmPopup component.
+ */
+export interface ConfirmPopupEmits {}
 
+/**
+ * **PrimeVue - ConfirmPopup**
+ *
+ * _ConfirmPopup displays a confirmation overlay displayed relatively to its target._
+ *
+ * [Live Demo](https://www.primevue.org/confirmpopup/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class ConfirmPopup extends ClassComponent<ConfirmPopupProps, ConfirmPopupSlots, ConfirmPopupEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -27,18 +56,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * ConfirmPopup displays a confirmation overlay displayed relatively to its target.
- *
- * Helper API:
- *
- * - Confirmation API
- * - ConfirmationService
- *
- * Demos:
- *
- * - [ConfirmPopup](https://www.primefaces.org/primevue/confirmpopup)
- *
- */
 export default ConfirmPopup;

package/contextmenu/ContextMenu.d.ts

@@ -1,9 +1,20 @@
+/**
+ *
+ * ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu.
+ * Refer to documentation of the individual documentation of the with context menu support.
+ *
+ * [Live Demo](https://www.primevue.org/contextmenu/)
+ *
+ * @module contextmenu
+ *
+ */
 import { VNode } from 'vue';
 import { MenuItem } from '../menuitem';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type ContextMenuAppendTo = 'body' | 'self' | string | undefined | HTMLElement;
-
+/**
+ * Defines valid properties in ContextMenu component.
+ */
 export interface ContextMenuProps {
     /**
      * An array of menuitems.
@@ -11,27 +22,27 @@ export interface ContextMenuProps {
     model?: MenuItem[] | undefined;
     /**
      * A valid query selector or an HTMLElement to specify where the overlay gets attached.
-     * @see ContextMenuAppendTo
-     * Default value is 'body'
+     * @defaultValue body
      */
-    appendTo?: ContextMenuAppendTo;
+    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;
     /**
      * Attaches the menu to document instead of a particular item.
+     * @defaultValue false
      */
     global?: boolean | 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;
     /**
@@ -48,48 +59,67 @@ export interface ContextMenuProps {
     'aria-labelledby'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in ContextMenu component.
+ */
 export interface ContextMenuSlots {
     /**
      * Custom item template.
      * @param {Object} scope - item slot's params.
      */
-    item: (scope: {
+    item(scope: {
         /**
          * Menuitem instance
          */
         item: MenuItem;
-    }) => VNode[];
+    }): VNode[];
 }
 
-export declare type ContextMenuEmits = {
+/**
+ * Defines valid emits in ContextMenu component.
+ */
+export interface ContextMenuEmits {
     /**
      * 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 - ContextMenu**
+ *
+ * _ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu.
+ * Refer to documentation of the individual documentation of the with context menu support._
+ *
+ * [Live Demo](https://www.primevue.org/contextmenu/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class ContextMenu extends ClassComponent<ContextMenuProps, ContextMenuSlots, ContextMenuEmits> {
     /**
      * Toggles the visibility of the menu.
@@ -97,20 +127,20 @@ declare class ContextMenu extends ClassComponent<ContextMenuProps, ContextMenuSl
      *
      * @memberof ContextMenu
      */
-    toggle: (event: Event) => void;
+    toggle(event: Event): void;
     /**
      * Shows the menu.
      * @param {Event} event - Browser event.
      *
      * @memberof ContextMenu
      */
-    show: (event: Event) => void;
+    show(event: Event): void;
     /**
      * Hides the menu.
      *
      * @memberof ContextMenu
      */
-    hide: () => void;
+    hide(): void;
 }
 
 declare module '@vue/runtime-core' {
@@ -119,18 +149,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu.
- * Refer to documentation of the individual documentation of the with context menu support.
- *
- * Helper API:
- *
- * - [MenuItem](https://www.primefaces.org/primevue/menumodel)
- *
- * Demos:
- *
- * - [ContextMenu](https://www.primefaces.org/primevue/contextmenu)
- *
- */
 export default ContextMenu;