primeng 20.2.0 → 20.3.0-rc.1

package/types/multiselect/index.d.ts

@@ -0,0 +1,362 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, ScrollerOptions } from 'primeng/api';
+import { CheckboxPassThrough } from 'primeng/types/checkbox';
+import { ChipPassThrough } from 'primeng/types/chip';
+import { IconFieldPassThrough } from 'primeng/types/iconfield';
+import { InputIconPassThrough } from 'primeng/types/inputicon';
+import { InputTextPassThrough } from 'primeng/types/inputtext';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ * @see {@link MultiSelect.pt}
+ * @group Interface
+ */
+interface MultiSelectPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, 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 clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the chip item's DOM element.
+     */
+    chipItem?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Chip component.
+     * @see {@link ChipPassThrough}
+     */
+    pcChip?: ChipPassThrough;
+    /**
+     * Used to pass attributes to the dropdown's DOM element.
+     */
+    dropdown?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the dropdown icon's DOM element.
+     */
+    dropdownIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the overlay's DOM element.
+     */
+    overlay?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header checkbox component.
+     * @see {@link CheckboxPassThrough}
+     */
+    pcHeaderCheckbox?: CheckboxPassThrough;
+    /**
+     * Used to pass attributes to the IconField component.
+     * @see {@link IconFieldPassThrough}
+     */
+    pcFilterContainer?: IconFieldPassThrough;
+    /**
+     * Used to pass attributes to the InputText component.
+     * @see {@link InputTextPassThrough}
+     */
+    pcFilter?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the InputIcon component.
+     * @see {@link InputIconPassThrough}
+     */
+    pcFilterIconContainer?: InputIconPassThrough;
+    /**
+     * Used to pass attributes to the filter icon's DOM element.
+     */
+    filterIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the list container's DOM element.
+     */
+    listContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the list's DOM element.
+     */
+    list?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the option group's DOM element.
+     */
+    optionGroup?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the option's DOM element.
+     */
+    option?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the option checkbox component.
+     * @see {@link CheckboxPassThrough}
+     */
+    pcOptionCheckbox?: CheckboxPassThrough;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLLIElement, I>;
+}
+/**
+ * Defines valid pass-through options in MultiSelect.
+ * @see {@link MultiSelectPassThroughOptions}
+ * @template I Type of instance.
+ */
+type MultiSelectPassThrough<I = unknown> = PassThrough<I, MultiSelectPassThroughOptions<I>>;
+/**
+ * Callbacks to invoke on filter or reset.
+ * @group Interface
+ */
+interface MultiSelectFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link MultiSelect.onChange}
+ * @group Events
+ */
+interface MultiSelectChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Current selected values.
+     */
+    value: any;
+    /**
+     * Toggled item value.
+     */
+    itemValue?: any;
+}
+/**
+ * Custom change event.
+ * @see {@link MultiSelect.onSelectAllChange}
+ * @group Events
+ */
+interface MultiSelectSelectAllChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Boolean value indicates whether all data is selected.
+     */
+    checked: boolean;
+}
+/**
+ * Custom filter event.
+ * @see {@link MultiSelect.onFilter}
+ * @group Events
+ */
+interface MultiSelectFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filter value.
+     */
+    filter: any;
+}
+/**
+ * Custom focus event.
+ * @see {@link MultiSelect.onFocus}
+ * @group Events
+ */
+interface MultiSelectFocusEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+}
+/**
+ * Custom blur event.
+ * @see {@link MultiSelect.onBlur}
+ * @extends {MultiSelectFocusEvent}
+ * @group Events
+ */
+interface MultiSelectBlurEvent extends MultiSelectFocusEvent {
+}
+/**
+ * Custom lazy load event.
+ * @see {@link MultiSelect.onLazyLoad}
+ * @group Events
+ */
+interface MultiSelectLazyLoadEvent {
+    /**
+     * Index of the first element in viewport.
+     */
+    first: number;
+    /**
+     * Index of the last element in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom remove event.
+ * @see {@link MultiSelect.onRemove}
+ * @group Events
+ */
+interface MultiSelectRemoveEvent {
+    /**
+     * Value after the item removed.
+     */
+    newValue: object;
+    /**
+     * Removed value.
+     */
+    removed: unknown;
+}
+/**
+ * Defines valid templates in MultiSelect.
+ * @group Templates
+ */
+interface MultiSelectTemplates {
+    /**
+     * Custom header template.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Data of the option.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom selected item template.
+     * @param {Object} context - selected items data.
+     */
+    selecteditems(context: {
+        /**
+         * Selected option value.
+         */
+        $implicit: any;
+        /**
+         * Function to remove chip.
+         */
+        removeChip: (chip: unknown, event: MouseEvent) => void;
+    }): TemplateRef<{
+        $implicit: any;
+        removeChip: Function;
+    }>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom filter template.
+     * @param {MultiSelectFilterOptions} options - filter options.
+     */
+    filter(context: {
+        /**
+         * Filter options.
+         */
+        options: MultiSelectFilterOptions;
+    }): TemplateRef<{
+        options: MultiSelectFilterOptions;
+    }>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom empty filter template.
+     */
+    emptyfilter(): TemplateRef<any>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom group template.
+     */
+    group(context: {
+        /**
+         * Data of the item.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom loader template. This template can be used with virtualScroll.
+     * @param {ScrollerOptions} options - virtual scroller options.
+     */
+    loader(context: {
+        /**
+         * Virtual scroller options.
+         */
+        options: ScrollerOptions;
+    }): TemplateRef<{
+        options: ScrollerOptions;
+    }>;
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    dropdownicon(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+    /**
+     * Custom check icon template.
+     * @deprecated Use headercheckboxicon or itemcheckboxicon instead.
+     */
+    checkicon(): TemplateRef<any>;
+    /**
+     * Custom check icon template for the header checkbox.
+     */
+    headercheckboxicon(context: {
+        /**
+         * Defines if all items are selected.
+         */
+        $implicit: boolean;
+        /**
+         * Defines if items are partially selected.
+         */
+        partialSelected: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+        partialSelected: boolean;
+    }>;
+    /**
+     * Custom check icon template for the item checkbox.
+     */
+    itemcheckboxicon(context: {
+        /**
+         * Selection status of the item.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<any>;
+    /**
+     * Custom remove token icon template.
+     */
+    removetokenicon(): TemplateRef<any>;
+}
+
+export type { MultiSelectBlurEvent, MultiSelectChangeEvent, MultiSelectFilterEvent, MultiSelectFilterOptions, MultiSelectFocusEvent, MultiSelectLazyLoadEvent, MultiSelectPassThrough, MultiSelectPassThroughOptions, MultiSelectRemoveEvent, MultiSelectSelectAllChangeEvent, MultiSelectTemplates };

package/types/orderlist/index.d.ts

@@ -0,0 +1,164 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+import { ListBoxPassThrough } from 'primeng/types/listbox';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link OrderList.pt}
+ * @group Interface
+ */
+interface OrderListPassThroughOptions<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 controls container's DOM element.
+     */
+    controls?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the move up button's DOM element.
+     */
+    pcMoveUpButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move top button's DOM element.
+     */
+    pcMoveTopButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move down button's DOM element.
+     */
+    pcMoveDownButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move bottom button's DOM element.
+     */
+    pcMoveBottomButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the Listbox component.
+     */
+    pcListbox?: ListBoxPassThrough;
+}
+/**
+ * Defines valid pass-through options in OrderList.
+ * @see {@link OrderListPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type OrderListPassThrough<I = unknown> = PassThrough<I, OrderListPassThroughOptions<I>>;
+/**
+ * Callbacks to invoke on filter.
+ * @group Interface
+ */
+interface OrderListFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link OrderList.selectionChange}
+ * @group Events
+ */
+interface OrderListSelectionChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Current selected values.
+     */
+    value: any[];
+}
+/**
+ * Custom change event.
+ * @see {@link OrderList.selectionChange}
+ * @group Events
+ */
+interface OrderListFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filtered options.
+     */
+    value: any[];
+}
+/**
+ * Defines valid templates in OrderList.
+ * @group Templates
+ */
+interface OrderListTemplates {
+    /**
+     * Custom header template.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+        /**
+         * Index of the item.
+         */
+        index: number;
+    }): TemplateRef<{
+        $implicit: any;
+        index: number;
+    }>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom filter template.
+     * @param {OrderListFilterOptions} options - filter options.
+     */
+    filter(context: {
+        /**
+         * Filter options.
+         */
+        options: OrderListFilterOptions;
+    }): TemplateRef<{
+        options: OrderListFilterOptions;
+    }>;
+    /**
+     * Custom empty filter template.
+     */
+    emptyfilter(): TemplateRef<any>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+    /**
+     * Custom move up icon template.
+     */
+    moveupicon(): TemplateRef<any>;
+    /**
+     * Custom move top icon template.
+     */
+    movetopicon(): TemplateRef<any>;
+    /**
+     * Custom move down icon template.
+     */
+    movedownicon(): TemplateRef<any>;
+    /**
+     * Custom move bottom icon template.
+     */
+    movebottomicon(): TemplateRef<any>;
+}
+
+export type { OrderListFilterEvent, OrderListFilterOptions, OrderListPassThrough, OrderListPassThroughOptions, OrderListSelectionChangeEvent, OrderListTemplates };

package/types/organizationchart/index.d.ts

@@ -0,0 +1,138 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, TreeNode } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link OrganizationChart.pt}
+ * @group Interface
+ */
+interface OrganizationChartPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the table's DOM element.
+     */
+    table?: PassThroughOption<HTMLTableElement, I>;
+    /**
+     * Used to pass attributes to the body's DOM element.
+     */
+    body?: PassThroughOption<HTMLTableSectionElement, I>;
+    /**
+     * Used to pass attributes to the row's DOM element.
+     */
+    row?: PassThroughOption<HTMLTableRowElement, I>;
+    /**
+     * Used to pass attributes to the cell's DOM element.
+     */
+    cell?: PassThroughOption<HTMLTableCellElement, I>;
+    /**
+     * Used to pass attributes to the node's DOM element.
+     */
+    node?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the node toggle button's DOM element.
+     */
+    nodeToggleButton?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the node toggle button icon's DOM element.
+     */
+    nodeToggleButtonIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the connectors' DOM element.
+     */
+    connectors?: PassThroughOption<HTMLTableRowElement, I>;
+    /**
+     * Used to pass attributes to the line cell's DOM element.
+     */
+    lineCell?: PassThroughOption<HTMLTableCellElement, I>;
+    /**
+     * Used to pass attributes to the connector down's DOM element.
+     */
+    connectorDown?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the connector left's DOM element.
+     */
+    connectorLeft?: PassThroughOption<HTMLTableCellElement, I>;
+    /**
+     * Used to pass attributes to the connector right's DOM element.
+     */
+    connectorRight?: PassThroughOption<HTMLTableCellElement, I>;
+    /**
+     * Used to pass attributes to the node children's DOM element.
+     */
+    nodeChildren?: PassThroughOption<HTMLTableRowElement, I>;
+    /**
+     * Used to pass attributes to the node cell's DOM element.
+     */
+    nodeCell?: PassThroughOption<HTMLTableCellElement, I>;
+}
+/**
+ * Defines valid pass-through options in OrganizationChart.
+ * @see {@link OrganizationChartPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type OrganizationChartPassThrough<I = unknown> = PassThrough<I, OrganizationChartPassThroughOptions<I>>;
+/**
+ * Custom node select event.
+ * @see {@link OrganizationChart.onNodeSelect}
+ * @group Events
+ */
+interface OrganizationChartNodeSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Node instance.
+     */
+    node: TreeNode;
+}
+/**
+ * Custom node unselect event.
+ * @see {@link OrganizationChart.onNodeUnSelect}
+ * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
+ */
+interface OrganizationChartNodeUnSelectEvent extends OrganizationChartNodeSelectEvent {
+}
+/**
+ * Custom node expand event.
+ * @see {@link OrganizationChart.onNodeExpand}
+ * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
+ */
+interface OrganizationChartNodeExpandEvent extends OrganizationChartNodeSelectEvent {
+}
+/**
+ * Custom node collapse event.
+ * @see {@link OrganizationChart.onNodeCollapse}
+ * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
+ */
+interface OrganizationChartNodeCollapseEvent extends OrganizationChartNodeSelectEvent {
+}
+/**
+ * Defines valid templates in OrganizationChart.
+ * @group Templates
+ */
+interface OrganizationChartTemplates {
+    /**
+     * Custom toggler icon template.
+     * @param {Object} context - item data.
+     */
+    togglericon(context: {
+        /**
+         * Expanded state of the node.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+}
+
+export type { OrganizationChartNodeCollapseEvent, OrganizationChartNodeExpandEvent, OrganizationChartNodeSelectEvent, OrganizationChartNodeUnSelectEvent, OrganizationChartPassThrough, OrganizationChartPassThroughOptions, OrganizationChartTemplates };

package/types/overlay/index.d.ts

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