primeng 20.1.2 → 20.3.0-rc.1

package/types/toolbar/index.d.ts

@@ -0,0 +1,55 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Toolbar.pt}
+ * @group Interface
+ */
+interface ToolbarPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the start's DOM element.
+     */
+    start?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the center's DOM element.
+     */
+    center?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the right's DOM element.
+     */
+    end?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Toolbar component.
+ * @see {@link ToolbarPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ToolbarPassThrough<I = unknown> = PassThrough<I, ToolbarPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Toolbar.
+ * @group Templates
+ */
+interface ToolbarTemplates {
+    /**
+     * Custom start content.
+     */
+    start(): TemplateRef<any>;
+    /**
+     * Custom end content.
+     */
+    end(): TemplateRef<any>;
+    /**
+     * Custom center content.
+     */
+    center(): TemplateRef<any>;
+}
+
+export type { ToolbarPassThrough, ToolbarPassThroughOptions, ToolbarTemplates };

package/types/tooltip/index.d.ts

@@ -0,0 +1,32 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Tooltip.pt}
+ * @group Interface
+ */
+interface TooltipPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the arrow's DOM element.
+     */
+    arrow?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the text's DOM element.
+     */
+    text?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tooltip.
+ * @see {@link TooltipPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TooltipPassThrough<I = unknown> = PassThrough<I, TooltipPassThroughOptions<I>>;
+
+export type { TooltipPassThrough, TooltipPassThroughOptions };

package/types/tree/index.d.ts

@@ -0,0 +1,308 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, TreeNode, ScrollerOptions } from 'primeng/api';
+import { CheckboxPassThrough } from 'primeng/types/checkbox';
+import { IconFieldPassThrough } from 'primeng/types/iconfield';
+import { InputIconPassThrough } from 'primeng/types/inputicon';
+import { InputTextPassThrough } from 'primeng/types/inputtext';
+import { VirtualScrollerPassThrough } from 'primeng/types/scroller';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Tree.pt}
+ * @group Interface
+ */
+interface TreePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the filter container's DOM element.
+     */
+    pcFilterContainer?: IconFieldPassThrough;
+    /**
+     * Used to pass attributes to the filter icon container's DOM element.
+     */
+    pcFilterIconContainer?: InputIconPassThrough;
+    /**
+     * Used to pass attributes to the filter input's DOM element.
+     */
+    pcFilterInput?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the filter icon's DOM element.
+     */
+    filterIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Scroller component.
+     */
+    pcScroller?: VirtualScrollerPassThrough;
+    /**
+     * Used to pass attributes to the wrapper's DOM element.
+     */
+    wrapper?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root children's DOM element.
+     */
+    rootChildren?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the node's DOM element.
+     */
+    node?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the drop point's DOM element.
+     */
+    dropPoint?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the node content's DOM element.
+     */
+    nodeContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the node toggle button's DOM element.
+     */
+    nodeToggleButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the node toggle icon's DOM element.
+     */
+    nodeTogglerIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the node checkbox's DOM element.
+     */
+    pcNodeCheckbox?: CheckboxPassThrough;
+    /**
+     * Used to pass attributes to the node icon's DOM element.
+     */
+    nodeIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the node label's DOM element.
+     */
+    nodeLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the node children's DOM element.
+     */
+    nodeChildren?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tree.
+ * @see {@link TreePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TreePassThrough<I = unknown> = PassThrough<I, TreePassThroughOptions<I>>;
+/**
+ * Custom node select event.
+ * @see {@link Tree.onNodeSelect}
+ * @group Events
+ */
+interface TreeNodeSelectEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Node instance.
+     */
+    node: TreeNode<any>;
+}
+/**
+ * Custom node unselect event.
+ * @see {@link Tree.onNodeUnSelect}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeUnSelectEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node expand event.
+ * @see {@link Tree.onNodeExpand}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeExpandEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node collapse event.
+ * @see {@link Tree.onNodeCollapse}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeCollapseEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom context menu select event.
+ * @see {@link Tree.onNodeContextMenuSelect}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeContextMenuSelectEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node double click event.
+ * @see {@link Tree.onNodeDoubleClick}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeDoubleClickEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node drop event.
+ * @see {@link Tree.onNodeDrop}
+ * @group Events
+ */
+interface TreeNodeDropEvent {
+    /**
+     * Browser drag event.
+     */
+    originalEvent?: DragEvent;
+    /**
+     * Dragged node instance.
+     */
+    dragNode?: TreeNode<any> | null;
+    /**
+     * Dropped node instance.
+     */
+    dropNode?: TreeNode<any> | null;
+    /**
+     * Index of the dragged node.
+     */
+    index?: number;
+    /**
+     * Callback to invoke on drop.
+     */
+    accept?: Function;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Tree.onLazyLoad}
+ * @group Events
+ */
+interface TreeLazyLoadEvent {
+    /**
+     * First element index in viewport.
+     */
+    first: number;
+    /**
+     * Last element index in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom scroll index change event.
+ * @see {@link Tree.onScrollIndexChange}
+ * @group Events
+ */
+interface TreeScrollIndexChangeEvent extends TreeLazyLoadEvent {
+}
+/**
+ * Custom scroll event.
+ * @see {@link Tree.onScroll}
+ * @group Events
+ */
+interface TreeScrollEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Custom filter event.
+ * @see {@link Tree.onFilter}
+ * @group Events
+ */
+interface TreeFilterEvent {
+    /**
+     * Filter value.
+     */
+    filter: string;
+    /**
+     * Filtered nodes.
+     */
+    filteredValue: TreeNode<any>[] | null | undefined;
+}
+/**
+ * Defines valid templates in Tree.
+ * @group Templates
+ */
+interface TreeTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom empty message template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom loader template.
+     * @param {Object} context - loader options.
+     */
+    loader(context: {
+        /**
+         * Scroller options.
+         * @see {@link ScrollerOptions}
+         */
+        options: ScrollerOptions;
+    }): TemplateRef<{
+        options: ScrollerOptions;
+    }>;
+    /**
+     * Custom toggler icon template.
+     * @param {Object} context - expand data.
+     */
+    togglericon(context: {
+        /**
+         * Expanded state of the node.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom checkbox icon template.
+     * @param {Object} context - node data.
+     */
+    checkboxicon(context: {
+        /**
+         * Checked state of the node.
+         */
+        $implicit: boolean;
+        /**
+         * Partial selection state of the node.
+         */
+        partialSelected: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+        partialSelected: boolean;
+    }>;
+    /**
+     * Custom loading icon template.
+     */
+    loadingicon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+}
+
+export type { TreeFilterEvent, TreeLazyLoadEvent, TreeNodeCollapseEvent, TreeNodeContextMenuSelectEvent, TreeNodeDoubleClickEvent, TreeNodeDropEvent, TreeNodeExpandEvent, TreeNodeSelectEvent, TreeNodeUnSelectEvent, TreePassThrough, TreePassThroughOptions, TreeScrollEvent, TreeScrollIndexChangeEvent, TreeTemplates };

package/types/treeselect/index.d.ts

@@ -0,0 +1,224 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, TreeNode } from 'primeng/api';
+import { ChipPassThrough } from 'primeng/types/chip';
+import { OverlayPassThrough } from 'primeng/types/overlay';
+import { TreePassThrough } from 'primeng/types/tree';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link TreeSelect.pt}
+ * @group Interface
+ */
+interface TreeSelectPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hidden input container's DOM element.
+     */
+    hiddenInputContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hidden input's DOM element.
+     */
+    hiddenInput?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the label container's DOM element.
+     */
+    labelContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the chip item's DOM element.
+     */
+    chipItem?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Chip component.
+     */
+    pcChip?: ChipPassThrough;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the dropdown's DOM element.
+     */
+    dropdown?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the dropdown icon's DOM element.
+     */
+    dropdownIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the panel's DOM element.
+     */
+    panel?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the first hidden focusable element's DOM element.
+     */
+    hiddenFirstFocusableEl?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the tree container's DOM element.
+     */
+    treeContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Tree component.
+     */
+    pcTree?: TreePassThrough;
+    /**
+     * Used to pass attributes to the last hidden focusable element's DOM element.
+     */
+    hiddenLastFocusableEl?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Overlay component.
+     */
+    pcOverlay?: OverlayPassThrough;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type TreeSelectPassThrough<I = unknown> = PassThrough<I, TreeSelectPassThroughOptions<I>>;
+/**
+ * Defines valid properties in TreeSelectNodeCollapseEvent.
+ * @group Interface
+ */
+interface TreeSelectNodeCollapseEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Collapsed node instance.
+     */
+    node: TreeNode;
+}
+/**
+ * Custom node collapse event.
+ * @see {@link TreeSelect.onNodeCollapse}
+ * @group Events
+ */
+interface TreeSelectNodeCollapseEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Node instance.
+     */
+    node: TreeNode;
+}
+/**
+ * Defines valid properties in TreeSelectNodeExpandEvent.
+ * @group Interface
+ */
+interface TreeSelectNodeExpandEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Expanded node instance.
+     */
+    node: TreeNode;
+}
+/**
+ * Custom node expand event.
+ * @see {@link TreeSelect.onNodeExpand}
+ * @group Events
+ */
+interface TreeSelectNodeExpandEvent extends TreeSelectNodeCollapseEvent {
+}
+/**
+ * Defines valid templates in TreeSelect.
+ * @group Templates
+ */
+interface TreeSelectTemplates {
+    /**
+     * Custom value template.
+     * @param {Object} context - value data.
+     */
+    value(context: {
+        /**
+         * Value of the component.
+         */
+        $implicit: TreeNode<any> | null;
+        /**
+         * Placeholder of the component.
+         */
+        placeholder: string;
+    }): TemplateRef<{
+        $implicit: TreeNode<any> | null;
+        placeholder: string;
+    }>;
+    /**
+     * Custom header template.
+     * @param {Object} context - header data.
+     */
+    header(context: {
+        /**
+         * Value of the component.
+         */
+        $implicit: TreeNode<any> | null | undefined;
+        /**
+         * Placeholder of the component.
+         */
+        options: TreeNode<any>[] | undefined;
+    }): TemplateRef<{
+        $implicit: TreeNode<any> | null;
+        options: TreeNode[] | null | undefined;
+    }>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    triggericon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<any>;
+    /**
+     * Custom node toggler template.
+     * @param {Object} context - toggler icon data.
+     */
+    itemtogglericon(context: {
+        /**
+         * Expanded state of the node.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: TreeNode<any> | null;
+    }>;
+    /**
+     * Custom node checkbox icon template.
+     */
+    itemcheckboxicon(): TemplateRef<any>;
+    /**
+     * Custom loading icon template.
+     */
+    itemloadingicon(): TemplateRef<any>;
+}
+
+export type { TreeSelectNodeCollapseEvent, TreeSelectNodeExpandEvent, TreeSelectPassThrough, TreeSelectPassThroughOptions, TreeSelectTemplates };