primevue 3.23.0 → 3.24.0

package/orderlist/OrderList.d.ts

@@ -1,6 +1,19 @@
+/**
+ *
+ * OrderList is used to managed the order of a collection.
+ *
+ * [Live Demo](https://primevue.org/orderlist)
+ *
+ * @module orderlist
+ *
+ */
 import { ButtonHTMLAttributes, HTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom reorder event
+ * @see {@link OrderListEmits.reorder}
+ */
 export interface OrderListReorderEvent {
     /**
      * Browser event
@@ -16,6 +29,10 @@ export interface OrderListReorderEvent {
     direction: string;
 }
 
+/**
+ * Custom selection change event
+ * @see {@link OrderListEmits['selection-change']}
+ */
 export interface OrderListSelectionChangeEvent {
     /**
      * Browser event
@@ -27,6 +44,9 @@ export interface OrderListSelectionChangeEvent {
     value: any[];
 }
 
+/**
+ * Defines valid properties in OrderList component.
+ */
 export interface OrderListProps {
     /**
      * Value of the component.
@@ -44,7 +64,7 @@ export interface OrderListProps {
      * Defines whether metaKey is requred or not for the selection.
      * When true metaKey needs to be pressed to select or unselect an item and
      * when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
-     * Default value is true.
+     * @defaultValue true
      */
     metaKeySelection?: boolean | undefined;
     /**
@@ -53,12 +73,12 @@ export interface OrderListProps {
     listStyle?: any;
     /**
      * Whether the list optimizes layout based on screen size.
-     * Default value is true.
+     * @defaultValue true
      */
     responsive?: boolean | undefined;
     /**
      * The breakpoint to define the maximum width boundary when responsiveness is enabled.
-     * Default value is '960px'.
+     * @defaultValue 960px
      */
     breakpoint?: string | undefined;
     /**
@@ -99,16 +119,19 @@ export interface OrderListProps {
     'aria-labelledby'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in OrderList component.
+ */
 export interface OrderListSlots {
     /**
      * Custom header template.
      */
-    header: () => VNode[];
+    header(): VNode[];
     /**
      * Custom item template.
      * @param {Object} scope - item slot's params.
      */
-    item: (scope: {
+    item(scope: {
         /**
          * Item of the component
          */
@@ -117,40 +140,54 @@ export interface OrderListSlots {
          * Index of the item.
          */
         index: number;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom controls start template.
      */
-    controlsstart: () => VNode[];
+    controlsstart(): VNode[];
     /**
      * Custom controls end template.
      */
-    controlsend: () => VNode[];
+    controlsend(): VNode[];
 }
 
-export declare type OrderListEmits = {
+/**
+ * Defines valid slots in OrderList component.
+ */
+export interface OrderListEmits {
     /**
      * Emitted when the value changes.
      * @param {*} value - New value.
      */
-    'update:modelValue': (value: any[]) => void;
+    'update:modelValue'(value: any[]): void;
     /**
      * Emitted when the selection changes.
      * @param {*} value - New value.
      */
-    'update:selection': (value: any[]) => void;
+    'update:selection'(value: any[]): void;
     /**
      * Callback to invoke when the list is reordered.
      * @param {OrderListReorderEvent} event - Custom reorder event.
      */
-    reorder: (event: OrderListReorderEvent) => void;
+    reorder(event: OrderListReorderEvent): void;
     /**
      * Callback to invoke when selection changes.
      * @param {OrderListSelectionChangeEvent} event - Custom selection change event.
      */
-    'selection-change': (event: OrderListSelectionChangeEvent) => void;
-};
+    'selection-change'(event: OrderListSelectionChangeEvent): void;
+}
 
+/**
+ * **PrimeVue - OrderList**
+ *
+ * _OrderList is used to sort a collection._
+ *
+ * [Live Demo](https://www.primevue.org/orderlist/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class OrderList extends ClassComponent<OrderListProps, OrderListSlots, OrderListEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -159,13 +196,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * OrderList is used to managed the order of a collection.
- *
- * Demos:
- *
- * - [OrderList](https://www.primefaces.org/primevue/orderlist)
- *
- */
 export default OrderList;

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.23.0",
-    "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;