primevue 3.22.4 → 3.24.0

package/tree/Tree.d.ts

@@ -1,6 +1,18 @@
+/**
+ *
+ * Tree is used to display hierarchical data.
+ *
+ * [Live Demo](https://www.primevue.org/tree/)
+ *
+ * @module tree
+ *
+ */
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+/**
+ * Custom TreeNode metadata.
+ */
 export interface TreeNode {
     /**
      * Mandatory unique key of the node.
@@ -56,12 +68,9 @@ export interface TreeNode {
     collapsedIcon?: string;
 }
 
-type TreeSelectionModeType = 'single' | 'multiple' | 'checkbox' | undefined;
-
-type TreeFilterModeType = 'lenient' | 'strict' | undefined;
-
-type TreeScrollHeightType = 'flex' | string | undefined;
-
+/**
+ * Custom expanded keys metadata.
+ */
 export interface TreeExpandedKeys {
     /**
      * Optional
@@ -69,6 +78,9 @@ export interface TreeExpandedKeys {
     [key: string]: any;
 }
 
+/**
+ * Custom selection keys metadata.
+ */
 export interface TreeSelectionKeys {
     /**
      * Optional
@@ -76,6 +88,9 @@ export interface TreeSelectionKeys {
     [key: string]: any;
 }
 
+/**
+ * Defines valid properties in Tree component.
+ */
 export interface TreeProps {
     /**
      * An array of treenodes.
@@ -92,20 +107,21 @@ export interface TreeProps {
     /**
      * Defines the selection mode.
      */
-    selectionMode?: TreeSelectionModeType;
+    selectionMode?: 'single' | 'multiple' | 'checkbox' | undefined;
     /**
      * Defines how multiple items can be selected, 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;
     /**
      * Whether to display loading indicator.
+     * @defaultValue false
      */
     loading?: boolean | undefined;
     /**
      * Icon to display when tree is loading.
-     * Default value is 'pi pi-spin'.
+     * @defaultValue pi pi-spin
      */
     loadingIcon?: string | undefined;
     /**
@@ -114,15 +130,14 @@ export interface TreeProps {
     filter?: boolean | undefined;
     /**
      * When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.
-     * Default valye is 'label'.
+     * @defaultValue label
      */
     filterBy?: string | undefined;
     /**
      * Mode for filtering.
-     * @see TreeFilterModeType
-     * Default value is 'lenient'.
+     * @defaultValue lenient
      */
-    filterMode?: TreeFilterModeType;
+    filterMode?: 'lenient' | 'strict' | undefined;
     /**
      * Placeholder text to show when filter input is empty.
      */
@@ -133,9 +148,8 @@ export interface TreeProps {
     filterLocale?: string | undefined;
     /**
      * Height of the scroll viewport in fixed units or the 'flex' keyword for a dynamic size.
-     * @see TreeScrollHeightType
      */
-    scrollHeight?: TreeScrollHeightType;
+    scrollHeight?: 'flex' | string | undefined;
     /**
      * Defines a string value that labels an interactive element.
      */
@@ -146,9 +160,13 @@ export interface TreeProps {
     'aria-labelledby'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in Tree component.
+ */
 export interface TreeSlots {
     /**
      * Optional slots.
+     * @todo
      */
     [key: string]: (scope: {
         /**
@@ -158,39 +176,53 @@ export interface TreeSlots {
     }) => VNode[];
 }
 
-export declare type TreeEmits = {
+/**
+ * Defines valid slots in Tree component.
+ */
+export interface TreeEmits {
     /**
      * Emitted when the expanded keys change.
      * @param {TreeNode} value - New expanded keys.
      */
-    'update:expandedKeys': (value: TreeExpandedKeys) => void;
+    'update:expandedKeys'(value: TreeExpandedKeys): void;
     /**
      * Emitted when the selection keys change.
      * @param {TreeSelectionKeys} value - New selection keys.
      */
-    'update:selectionKeys': (event: TreeSelectionKeys) => void;
+    'update:selectionKeys'(event: TreeSelectionKeys): void;
     /**
      * Callback to invoke when a node is selected.
      * @param {TreeNode} node - Node instance.
      */
-    'node-select': (node: TreeNode) => void;
+    'node-select'(node: TreeNode): void;
     /**
      * Callback to invoke when a node is unselected.
      * @param {TreeNode} node - Node instance.
      */
-    'node-unselect': (node: TreeNode) => void;
+    'node-unselect'(node: TreeNode): void;
     /**
      * Callback to invoke when a node is expanded.
      * @param {TreeNode} node - Node instance.
      */
-    'node-expand': (node: TreeNode) => void;
+    'node-expand'(node: TreeNode): void;
     /**
      * Callback to invoke when a node is collapsed.
      * @param {TreeNode} node - Node instance.
      */
-    'node-collapse': (node: TreeNode) => void;
-};
+    'node-collapse'(node: TreeNode): void;
+}
 
+/**
+ * **PrimeVue - Tree**
+ *
+ * _Tree is used to display hierarchical data._
+ *
+ * [Live Demo](https://www.primevue.org/tree/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class Tree extends ClassComponent<TreeProps, TreeSlots, TreeEmits> {}
 
 declare module '@vue/runtime-core' {
@@ -199,17 +231,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * Tree is used to display hierarchical data.
- *
- * Helper API:
- *
- * - TreeNode
- *
- * Demos:
- *
- * - [Tree](https://www.primefaces.org/primevue/tree)
- *
- */
 export default Tree;

package/treeselect/TreeSelect.d.ts

@@ -1,13 +1,19 @@
-import { VNode } from 'vue';
-import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
+/**
+ *
+ * TreeSelect is a form component to choose from hierarchical data.
+ *
+ * [Live Demo](https://www.primevue.org/treeselect/)
+ *
+ * @module treeselect
+ *
+ */
+import { InputHTMLAttributes, VNode } from 'vue';
 import { TreeNode } from '../tree';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
-type TreeSelectSelectionModeType = 'single' | 'multiple' | 'checkbox' | undefined;
-
-type TreeSelectAppendToType = 'body' | 'self' | string | undefined | HTMLElement;
-
-type TreeSelectDisplayType = 'comma' | 'chip' | undefined;
-
+/**
+ * Defines valid properties in TreeSelect component.
+ */
 export interface TreeSelectProps {
     /**
      * Value of the component.
@@ -19,7 +25,7 @@ export interface TreeSelectProps {
     options?: TreeNode[] | undefined;
     /**
      * Height of the viewport, a scrollbar is defined if height of list exceeds this value.
-     * Default value is '200px'.
+     * @defaultValue 200px
      */
     scrollHeight?: string | undefined;
     /**
@@ -28,6 +34,7 @@ export interface TreeSelectProps {
     placeholder?: string | undefined;
     /**
      * When present, it specifies that the component should be disabled.
+     * @defaultValue false
      */
     disabled?: boolean | undefined;
     /**
@@ -36,34 +43,31 @@ export interface TreeSelectProps {
     tabindex?: string | undefined;
     /**
      * Defines the selection mode.
-     * @see TreeSelectSelectionModeType
      */
-    selectionMode?: TreeSelectSelectionModeType;
+    selectionMode?: 'single' | 'multiple' | 'checkbox' | undefined;
     /**
      * Style class of the overlay panel.
      */
     panelClass?: any;
     /**
-     * A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are 'body' for document body and 'self' for the element itself.
-     * @see TreeSelectAppendToType
-     * Default value is 'body'.
+     * A valid query selector or an HTMLElement to specify where the overlay gets attached.
+     * @defaultValue body
      */
-    appendTo?: TreeSelectAppendToType;
+    appendTo?: 'body' | 'self' | string | undefined | HTMLElement;
     /**
      * Text to display when there are no options available. Defaults to value from PrimeVue locale configuration.
-     * Default value is 'No results found'.
+     * @defaultValue No results found
      */
     emptyMessage?: string | undefined;
     /**
      * Defines how the selected items are displayed.
-     * @see TreeSelectDisplayType
-     * Default value is 'comma'.
+     * @defaultValue comma
      */
-    display?: TreeSelectDisplayType;
+    display?: 'comma' | 'chip' | undefined;
     /**
      * Defines how multiple items can be selected, 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;
     /**
@@ -79,9 +83,9 @@ export interface TreeSelectProps {
      */
     inputStyle?: any | undefined;
     /**
-     *
+     * Uses to pass all properties of the HTMLInputElement to the focusable input element inside the component.
      */
-    inputProps?: object | undefined;
+    inputProps?: InputHTMLAttributes | undefined;
     /**
      * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
      */
@@ -92,12 +96,15 @@ export interface TreeSelectProps {
     'aria-label'?: string | undefined;
 }
 
+/**
+ * Defines valid slots in TreeSelect component.
+ */
 export interface TreeSelectSlots {
     /**
      * Custom value template.
      * @param {Object} scope - value slot's params.
      */
-    value: (scope: {
+    value(scope: {
         /**
          * Selected value
          */
@@ -106,12 +113,12 @@ export interface TreeSelectSlots {
          * Placeholder
          */
         placeholder: string;
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom header template.
      * @param {Object} scope - header slot's params.
      */
-    header: (scope: {
+    header(scope: {
         /**
          * Selected value
          */
@@ -120,12 +127,12 @@ export interface TreeSelectSlots {
          * An array of treenodes.
          */
         options: TreeNode[];
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom footer template.
      * @param {Object} scope - footer slot's params.
      */
-    footer: (scope: {
+    footer(scope: {
         /**
          * Selected value
          */
@@ -134,66 +141,80 @@ export interface TreeSelectSlots {
          * An array of treenodes.
          */
         options: TreeNode[];
-    }) => VNode[];
+    }): VNode[];
     /**
      * Custom empty template.
      */
-    empty: () => VNode[];
+    empty(): VNode[];
     /**
      * Custom indicator template.
      */
-    indicator: () => VNode[];
+    indicator(): VNode[];
 }
 
-export declare type TreeSelectEmits = {
+/**
+ * Defines valid emits in TreeSelect component.
+ */
+export interface TreeSelectEmits {
     /**
      * Emitted when the value changes.
      * @param {*} value - New value.
      */
-    'update:modelValue': (value: any) => void;
+    'update:modelValue'(value: any): void;
     /**
      * Callback to invoke on value change.
      * @param {*} value - Selected node keys
      */
-    change: (value: string[]) => void;
+    change(value: string[]): void;
     /**
      * Callback to invoke before the overlay is shown.
      */
-    'before-show': () => void;
+    'before-show'(): void;
     /**
      * Callback to invoke before the overlay is hidden.
      */
-    'before-hide': () => void;
+    'before-hide'(): void;
     /**
      * Callback to invoke when the overlay is shown.
      */
-    show: () => void;
+    show(): void;
     /**
      * Callback to invoke when the overlay is hidden.
      */
-    hide: () => void;
+    hide(): void;
     /**
      * Callback to invoke when a node is selected.
      * @param {TreeNode} node - Node instance.
      */
-    'node-select': (node: TreeNode) => void;
+    'node-select'(node: TreeNode): void;
     /**
      * Callback to invoke when a node is unselected.
      * @param {TreeNode} node - Node instance.
      */
-    'node-unselect': (node: TreeNode) => void;
+    'node-unselect'(node: TreeNode): void;
     /**
      * Callback to invoke when a node is expanded.
      * @param {TreeNode} node - Node instance.
      */
-    'node-expand': (node: TreeNode) => void;
+    'node-expand'(node: TreeNode): void;
     /**
      * Callback to invoke when a node is collapsed.
      * @param {TreeNode} node - Node instance.
      */
-    'node-collapse': (node: TreeNode) => void;
-};
+    'node-collapse'(node: TreeNode): void;
+}
 
+/**
+ * **PrimeVue - TreeSelect**
+ *
+ * _TreeSelect is a form component to choose from hierarchical data._
+ *
+ * [Live Demo](https://www.primevue.org/treeselect/)
+ * --- ---
+ * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
+ *
+ * @group Component
+ */
 declare class TreeSelect extends ClassComponent<TreeSelectProps, TreeSelectSlots, TreeSelectEmits> {
     /**
      * Shows the overlay.
@@ -215,17 +236,4 @@ declare module '@vue/runtime-core' {
     }
 }
 
-/**
- *
- * TreeSelect is a form component to choose from hierarchical data.
- *
- * Helper API:
- *
- * - TreeNode
- *
- * Demos:
- *
- * - [TreeSelect](https://www.primefaces.org/primevue/treeselect)
- *
- */
 export default TreeSelect;