primevue 3.22.4 → 3.24.0

package/organizationchart/OrganizationChart.d.ts

@@ -1,8 +1,18 @@
+/**
+ *
+ * OrganizationChart visualizes hierarchical organization data.
+ *
+ * [Live Demo](https://primevue.org/organizationchart)
+ *
+ * @module organizationchart
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type OrganizationChartSelectionModeType = 'single' | 'multiple' | undefined;
-
+/**
+ * Defines valid properties in OrganizationChartNode.
+ */
 export interface OrganizationChartNode {
     /**
      * Unique identifier of the node. (required)
@@ -54,6 +64,9 @@ export interface OrganizationChartCollapsedKeys {
     [key: string]: any;
 }
 
+/**
+ * Defines valid properties in OrganizationChart component.
+ */
 export interface OrganizationChartProps {
     /**
      * Value of the component.
@@ -65,9 +78,8 @@ export interface OrganizationChartProps {
     selectionKeys?: OrganizationChartSelectionKeys;
     /**
      * Type of the selection.
-     * @see OrganizationChartSelectionModeType
      */
-    selectionMode?: OrganizationChartSelectionModeType;
+    selectionMode?: 'single' | 'multiple' | undefined;
     /**
      * A map instance of key-value pairs to represented the collapsed nodes.
      */
@@ -78,50 +90,68 @@ export interface OrganizationChartProps {
     collapsible?: boolean;
 }
 
+/**
+ * Defines valid slots in OrganizationChart component.
+ */
 export interface OrganizationChartSlots {
     /**
      * Custom content template.
      */
-    default: (node: any) => VNode[];
+    default(node: any): VNode[];
     /**
      * Dynamic content template.
+     * @todo
      */
     [key: string]: (node: any) => VNode[];
 }
 
-type OrganizationChartEmits = {
+/**
+ * Defines valid emits in OrganizationChart component.
+ */
+export interface OrganizationChartEmits {
     /**
      * Emitted when the value changes.
      * @param {*} value - New value.
      */
-    'update:selectionKeys': (value: any) => void;
+    'update:selectionKeys'(value: any): void;
     /**
      * Emitted when the value changes.
      * @param {boolean} value - New value.
      */
-    'update:collapsedKeys': (value: boolean) => void;
+    'update:collapsedKeys'(value: boolean): void;
     /**
      * Callback to invoke when a suggestion is selected.
      * @param {OrganizationChartNode} node - Node instance.
      */
-    'node-select': (node: OrganizationChartNode) => void;
+    'node-select'(node: OrganizationChartNode): void;
     /**
      * Callback to invoke when a node is unselected.
      * @param {OrganizationChartNode} node - Node instance.
      */
-    'node-unselect': (node: OrganizationChartNode) => void;
+    'node-unselect'(node: OrganizationChartNode): void;
     /**
      * Callback to invoke when a node is expanded.
      * @param {OrganizationChartNode} node - Node instance.
      */
-    'node-expand': (node: OrganizationChartNode) => void;
+    'node-expand'(node: OrganizationChartNode): void;
     /**
      * Callback to invoke when a node is collapsed.
      * @param {OrganizationChartNode} node - Node instance.
      */
-    'node-collapsed': (node: OrganizationChartNode) => void;
-};
+    'node-collapsed'(node: OrganizationChartNode): void;
+}
 
+/**
+ * **PrimeVue - OrganizationChart**
+ *
+ * _OrganizationChart visualizes hierarchical organization data._
+ *
+ * [Live Demo](https://www.primevue.org/organizationchart/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class OrganizationChart extends ClassComponent<OrganizationChartProps, OrganizationChartSlots, OrganizationChartEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -130,17 +160,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * OrganizationChart visualizes hierarchical organization data.
- *
- * Helper API:
- *
- * - OrganizationChartNode
- *
- * Demos:
- *
- * - [OrganizationChart](https://www.primefaces.org/primevue/organizationchart)
- *
- */
 export default OrganizationChart;

package/overlaypanel/OverlayPanel.d.ts

@@ -1,8 +1,18 @@
+/**
+ *
+ * OverlayPanel is a container component positioned as connected to its target.
+ *
+ * [Live Demo](https://primevue.org/overlaypanel)
+ *
+ * @module overlaypanel
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type OverlayPanelAppendToType = 'body' | 'self' | string | undefined | HTMLElement;
-
+/**
+ * OverlayPanel breakpoint metadata.
+ */
 export interface OverlayPanelBreakpoints {
     /**
      * Breakpoint for responsive mode.
@@ -22,57 +32,76 @@ export interface OverlayPanelBreakpoints {
     [key: string]: string;
 }
 
+/**
+ * Defines valid properties in OverlayPanel component.
+ */
 export interface OverlayPanelProps {
     /**
      * Enables to hide the overlay when outside is clicked.
-     * Default value is true.
+     * @defaultValue true
      */
     dismissable?: boolean;
     /**
      * When enabled, displays a close icon at top right corner.
+     * @defaultValue false
      */
     showCloseIcon?: boolean;
     /**
      * A valid query selector or an HTMLElement to specify where the overlay gets attached.
-     * @see OverlayPanelAppendToType
-     * Default value is 'body'.
+     * @defaultValue body
      */
-    appendTo?: OverlayPanelAppendToType;
+    appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
     /**
      * Base zIndex value to use in layering.
-     * Default value is 0.
+     * @defaultValue 0
      */
     baseZIndex?: number;
     /**
      * Whether to automatically manage layering.
-     * Default value is true.
+     * @defaultValue true
      */
     autoZIndex?: boolean;
     /**
      * Object literal to define widths per screen size.
-     * @see OverlayPanelBreakpoints
      */
     breakpoints?: OverlayPanelBreakpoints;
 }
 
+/**
+ * Defines valid slots in OverlayPanel component.
+ */
 export interface OverlayPanelSlots {
     /**
      * Custom content template.
      */
-    default: () => VNode[];
+    default(): VNode[];
 }
 
-export declare type OverlayPanelEmits = {
+/**
+ * Defines valid emits in OverlayPanel component.
+ */
+export interface OverlayPanelEmits {
     /**
      * Callback to invoke when the overlay is shown.
      */
-    show: () => void;
+    show(): void;
     /**
      * Callback to invoke when the overlay is hidden.
      */
-    hide: () => void;
-};
+    hide(): void;
+}
 
+/**
+ * **PrimeVue - OverlayPanel**
+ *
+ * _OverlayPanel, also known as Popover, is a container component that can overlay other components on page._
+ *
+ * [Live Demo](https://www.primevue.org/overlaypanel/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class OverlayPanel extends ClassComponent<OverlayPanelProps, OverlayPanelSlots, OverlayPanelEmits> {
     /**
      * Toggles the visibility of the overlay.
@@ -81,7 +110,7 @@ declare class OverlayPanel extends ClassComponent<OverlayPanelProps, OverlayPane
      *
      * @memberof OverlayPanel
      */
-    toggle: (event: Event, target?: any) => void;
+    toggle(event: Event, target?: any): void;
     /**
      * Shows the overlay.
      * @param {Event} event - Browser event.
@@ -89,13 +118,13 @@ declare class OverlayPanel extends ClassComponent<OverlayPanelProps, OverlayPane
      *
      * @memberof OverlayPanel
      */
-    show: (event: Event, target?: any) => void;
+    show(event: Event, target?: any): void;
     /**
      * Hides the overlay.
      *
      * @memberof OverlayPanel
      */
-    hide: () => void;
+    hide(): void;
 }
 
 declare module '@vue/runtime-core' {
@@ -104,13 +133,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * OverlayPanel is a container component positioned as connected to its target.
- *
- * Demos:
- *
- * - [OverlayPanel](https://www.primefaces.org/primevue/overlaypanel)
- *
- */
 export default OverlayPanel;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "primevue",
-    "version": "3.22.4",
-    "homepage": "https://www.primefaces.org/primevue",
+    "version": "3.24.0",
+    "homepage": "https://primevue.org/",
     "repository": {
       "type": "git",
       "url": "https://github.com/primefaces/primevue.git"

package/paginator/Paginator.d.ts

@@ -1,6 +1,18 @@
+/**
+ *
+ * Paginator is a generic component to display content in paged format.
+ *
+ * - [Paginator](https://primevue.org/paginator)
+ *
+ * @module paginator
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Paginator page state metadata.
+ */
 export interface PageState {
     /**
      * Index of first record
@@ -20,25 +32,28 @@ export interface PageState {
     pageCount?: number;
 }
 
+/**
+ * Defines valid properties in Paginator component.
+ */
 export interface PaginatorProps {
     /**
      * Number of total records.
-     * Default value is 0.
+     * @defaultValue 0
      */
     totalRecords?: number | undefined;
     /**
      * Data count to display per page.
-     * Default value is 0.
+     * @defaultValue 0
      */
     rows?: number | undefined;
     /**
      * Zero-relative number of the first row to be displayed.
-     * Default value is 0.
+     * @defaultValue 0
      */
     first?: number | undefined;
     /**
      * Number of page links to display.
-     * Default value is 5.
+     * @defaultValue 5
      */
     pageLinkSize?: number | undefined;
     /**
@@ -60,7 +75,7 @@ export interface PaginatorProps {
      */
     template?: any | string;
     /**
-     * Template of the current page report element. It displays information about the pagination state. Default value is ({currentPage} of {totalPages}) whereas available placeholders are the following;
+     * Template of the current page report element. It displays information about the pagination state. Available placeholders are the following;
      *
      * - {currentPage}
      * - {totalPages}
@@ -68,58 +83,77 @@ export interface PaginatorProps {
      * - {first}
      * - {last}
      * - {totalRecords}
+     *
+     * @defaultValue '({currentPage} of {totalPages})'
      */
     currentPageReportTemplate?: string | undefined;
     /**
      * Whether to show the paginator even there is only one page.
-     * Default value is true.
+     * @defaultValue true
      */
     alwaysShow?: boolean | undefined;
 }
 
+/**
+ * Defines valid slots in Paginator component.
+ */
 export interface PaginatorSlots {
     /**
      * Custom start template.
      * @param {Object} scope - start slot's params.
      */
-    start: (scope: {
+    start(scope: {
         /**
          * Current state
          * @see PageState
          */
         state: PageState;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom end template.
      * @param {Object} scope - end slot's params.
      */
-    end: (scope: {
+    end(scope: {
         /**
          * Current state
          * @see PageState
          */
         state: PageState;
-    }) => VNode[];
+    }): VNode[];
 }
 
-export declare type PaginatorEmits = {
+/**
+ * Defines valid emits in Paginator component.
+ */
+export interface PaginatorEmits {
     /**
      * Emitted when the first changes.
      * @param {number} value - New value.
      */
-    'update:first': (value: number) => void;
+    'update:first'(value: number): void;
     /**
      * Emitted when the rows changes.
      * @param {number} value - New value.
      */
-    'update:rows': (value: number) => void;
+    'update:rows'(value: number): void;
     /**
      * Callback to invoke when page changes, the event object contains information about the new state.
      * @param {PageState} event - New page state.
      */
-    page: (event: PageState) => void;
-};
+    page(event: PageState): void;
+}
 
+/**
+ * **PrimeVue - Paginator**
+ *
+ * _Paginator is a generic widget to display content in paged format._
+ *
+ * [Live Demo](https://www.primevue.org/paginator/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class Paginator extends ClassComponent<PaginatorProps, PaginatorSlots, PaginatorEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -128,13 +162,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Paginator is a generic component to display content in paged format.
- *
- * Demos:
- *
- * - [Paginator](https://www.primefaces.org/primevue/paginator)
- *
- */
 export default Paginator;

package/panel/Panel.d.ts

@@ -1,6 +1,19 @@
+/**
+ *
+ * Panel is a container with the optional content toggle feature.
+ *
+ * [Live Demo](https://www.primevue.org/panel/)
+ *
+ * @module panel
+ *
+ */
 import { ButtonHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom toggle event.
+ * @see {@link PanelEmits.toggle}
+ */
 export interface PanelToggleEvent {
     /**
      * Browser event.
@@ -12,6 +25,9 @@ export interface PanelToggleEvent {
     value: boolean;
 }
 
+/**
+ * Defines valid properties in Panel component.
+ */
 export interface PanelProps {
     /**
      * Header text of the panel.
@@ -31,22 +47,28 @@ export interface PanelProps {
     toggleButtonProps?: ButtonHTMLAttributes | undefined;
 }
 
+/**
+ * Defines valid slots in Panel slots.
+ */
 export interface PanelSlots {
     /**
      * Custom content template.
      */
-    default: () => VNode[];
+    default(): VNode[];
     /**
      * Custom header template.
      */
-    header: () => VNode[];
+    header(): VNode[];
     /**
      * Custom icons template.
      */
-    icons: () => VNode[];
+    icons(): VNode[];
 }
 
-export declare type PanelEmits = {
+/**
+ * Defines valid emits in Panel component.
+ */
+export interface PanelEmits {
     /**
      * Emitted when the collapsed changes.
      * @param {boolean} value - New value.
@@ -57,8 +79,20 @@ export declare type PanelEmits = {
      * @param {PanelToggleEvent} event - Custom toggle event.
      */
     toggle: (event: PanelToggleEvent) => void;
-};
+}
 
+/**
+ * **PrimeVue - Panel**
+ *
+ * _Panel is a container with the optional content toggle feature._
+ *
+ * [Live Demo](https://www.primevue.org/panel/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class Panel extends ClassComponent<PanelProps, PanelSlots, PanelEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -67,13 +101,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Panel is a container with the optional content toggle feature.
- *
- * Demos:
- *
- * - [Panel](https://www.primefaces.org/primevue/panel)
- *
- */
 export default Panel;

package/panelmenu/PanelMenu.d.ts

@@ -1,11 +1,28 @@
+/**
+ *
+ * PanelMenu is a hybrid of Accordion and Tree components.
+ *
+ * [Live Demo](https://www.primevue.org/panelmenu/)
+ *
+ * @module panelmenu
+ *
+ */
 import { VNode } from 'vue';
 import { MenuItem } from '../menuitem';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom expanded keys metadata.
+ * @see {@link PanelMenuProps.expandedKeys}
+ */
 export interface PanelMenuExpandedKeys {
     [key: string]: any;
 }
 
+/**
+ * Custom panel open event.
+ * @see {@link PanelMenuEmits['panel-open']}
+ */
 export interface PanelMenuPanelOpenEvent {
     /**
      * Browser mouse event.
@@ -19,10 +36,15 @@ export interface PanelMenuPanelOpenEvent {
 }
 
 /**
+ * Custom panel close event.
+ * @see {@link PanelMenuEmits['panel-close']}
  * @extends {PanelMenuPanelOpenEvent}
  */
 export interface PanelMenuPanelCloseEvent extends PanelMenuPanelOpenEvent {}
 
+/**
+ * Defines valid properties in PanelMenu component.
+ */
 export interface PanelMenuProps {
     /**
      * An array of menuitems.
@@ -30,11 +52,12 @@ export interface PanelMenuProps {
     model?: MenuItem[] | undefined;
     /**
      * A map of keys to represent the expansion state in controlled mode.
-     * @see PanelMenuExpandedKeys
+     * @type {PanelMenuExpandedKeys}
      */
     expandedKeys?: PanelMenuExpandedKeys;
     /**
      * Whether to apply 'router-link-active-exact' class if route exactly matches the item path.
+     * @defaultValue true
      */
     exact?: boolean | undefined;
     /**
@@ -43,37 +66,55 @@ export interface PanelMenuProps {
     tabindex?: number | string | undefined;
 }
 
+/**
+ * Defines valid slots in PanelMenu component.
+ */
 export interface PanelMenuSlots {
     /**
      * 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 PanelMenuEmits = {
+/**
+ * Defines valid emits in PanelMenu component.
+ */
+export interface PanelMenuEmits {
     /**
      * Emitted when the expandedKeys changes.
      * @param {*} value - New value.
      */
-    'update:expandedKeys': (value: any) => void;
+    'update:expandedKeys'(value: any): void;
     /**
      * Callback to invoke when a panel gets expanded.
      * @param {PanelMenuPanelOpenEvent} event - Custom panel open event.
      */
-    'panel-open': (event: PanelMenuPanelOpenEvent) => void;
+    'panel-open'(event: PanelMenuPanelOpenEvent): void;
     /**
      * Callback to invoke when an active panel is collapsed by clicking on the header.
      * @param {PanelMenuPanelCloseEvent} event - Custom panel close event.
      */
-    'panel-close': (event: PanelMenuPanelCloseEvent) => void;
-};
+    'panel-close'(event: PanelMenuPanelCloseEvent): void;
+}
 
+/**
+ * **PrimeVue - PanelMenu**
+ *
+ * _PanelMenu is a hybrid of Accordion and Tree components._
+ *
+ * [Live Demo](https://www.primevue.org/panelmenu/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ *
+ */
 declare class PanelMenu extends ClassComponent<PanelMenuProps, PanelMenuSlots, PanelMenuEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -82,17 +123,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * PanelMenu is a hybrid of Accordion and Tree components.
- *
- * Helper API:
- *
- * - [MenuItem](https://www.primefaces.org/primevue/menumodel)
- *
- * Demos:
- *
- * - [PanelMenu](https://www.primefaces.org/primevue/panelmenu)
- *
- */
 export default PanelMenu;