primeng 16.0.0-rc.1 → 16.0.0

package/multiselect/multiselect.interface.d.ts

@@ -0,0 +1,204 @@
+import { TemplateRef } from '@angular/core';
+import { ScrollerOptions } from 'primeng/api';
+import { MultiSelectItem } from './multiselect';
+/**
+ * Callbacks to invoke on filter or reset.
+ * @group Interface
+ */
+export interface MultiSelectFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link MultiSelect.onChange}
+ * @group Events
+ */
+export interface MultiSelectChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Current selected values.
+     */
+    value: any;
+    /**
+     * Toggled item value.
+     */
+    itemValue?: any;
+}
+/**
+ * Custom filter event.
+ * @see {@link MultiSelect.onFilter}
+ * @group Events
+ */
+export interface MultiSelectFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filter value.
+     */
+    filter: any;
+}
+/**
+ * Custom focus event.
+ * @see {@link MultiSelect.onFocus}
+ * @group Events
+ */
+export interface MultiSelectFocusEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+}
+/**
+ * Custom blur event.
+ * @see {@link MultiSelect.onBlur}
+ * @extends {MultiSelectFocusEvent}
+ * @group Events
+ */
+export interface MultiSelectBlurEvent extends MultiSelectFocusEvent {
+}
+/**
+ * Custom lazy load event.
+ * @see {@link MultiSelect.onLazyLoad}
+ * @group Events
+ */
+export 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
+ */
+export interface MultiSelectRemoveEvent {
+    /**
+     * Value after the item removed.
+     */
+    newValue: object;
+    /**
+     * Removed value.
+     */
+    removed: MultiSelectItem;
+}
+/**
+ * Defines valid templates in MultiSelect.
+ * @group Templates
+ */
+export 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: MultiSelectItem, 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.
+     */
+    checkicon(): TemplateRef<any>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<any>;
+    /**
+     * Custom remove token icon template.
+     */
+    removetokenicon(): TemplateRef<any>;
+}

package/multiselect/public_api.d.ts

@@ -1 +1,2 @@
 export * from './multiselect';
+export * from './multiselect.interface';

package/orderlist/orderlist.d.ts

@@ -1,6 +1,8 @@
 import { ElementRef, AfterViewChecked, AfterContentInit, QueryList, TemplateRef, EventEmitter, ChangeDetectorRef, Renderer2 } from '@angular/core';
-import { FilterService } from 'primeng/api';
+import { PrimeTemplate, FilterService } from 'primeng/api';
 import { CdkDragDrop } from '@angular/cdk/drag-drop';
+import { Nullable } from 'primeng/ts-helpers';
+import { OrderListFilterEvent, OrderListFilterOptions, OrderListSelectionChangeEvent } from './orderlist.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/button";
@@ -12,10 +14,10 @@ import * as i7 from "primeng/icons/angledoubleup";
 import * as i8 from "primeng/icons/angleup";
 import * as i9 from "primeng/icons/angledown";
 import * as i10 from "primeng/icons/search";
-export interface OrderListFilterOptions {
-    filter?: (value?: any) => void;
-    reset?: () => void;
-}
+/**
+ * OrderList is used to managed the order of a collection.
+ * @group Components
+ */
 export declare class OrderList implements AfterViewChecked, AfterContentInit {
     private document;
     private platformId;
@@ -23,63 +25,167 @@ export declare class OrderList implements AfterViewChecked, AfterContentInit {
     el: ElementRef;
     cd: ChangeDetectorRef;
     filterService: FilterService;
-    header: string;
-    style: any;
-    styleClass: string;
-    listStyle: any;
-    responsive: boolean;
-    filterBy: string;
-    filterPlaceholder: string;
-    filterLocale: string;
+    /**
+     * Text for the caption.
+     * @group Props
+     */
+    header: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the list element.
+     * @group Props
+     */
+    listStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * A boolean value that indicates whether the component should be responsive.
+     * @group Props
+     */
+    responsive: boolean | undefined;
+    /**
+     * When specified displays an input field to filter the items on keyup and decides which fields to search against.
+     * @group Props
+     */
+    filterBy: string | undefined;
+    /**
+     * Placeholder of the filter input.
+     * @group Props
+     */
+    filterPlaceholder: string | undefined;
+    /**
+     * Locale to use in filtering. The default locale is the host environment's current locale.
+     * @group Props
+     */
+    filterLocale: string | undefined;
+    /**
+     * 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.
+     * @group Props
+     */
     metaKeySelection: boolean;
+    /**
+     * Whether to enable dragdrop based reordering.
+     * @group Props
+     */
     dragdrop: boolean;
-    controlsPosition: string;
-    ariaFilterLabel: string;
-    filterMatchMode: string;
+    /**
+     * Defines the location of the buttons with respect to the list.
+     * @group Props
+     */
+    controlsPosition: 'left' | 'right';
+    /**
+     * Defines a string that labels the filter input.
+     * @group Props
+     */
+    ariaFilterLabel: string | undefined;
+    /**
+     * Defines how the items are filtered.
+     * @group Props
+     */
+    filterMatchMode: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte';
+    /**
+     * Indicates the width of the screen at which the component should change its behavior.
+     * @group Props
+     */
     breakpoint: string;
-    stripedRows: boolean;
+    /**
+     * Whether to displays rows with alternating colors.
+     * @group Props
+     */
+    stripedRows: boolean | undefined;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @group Props
+     */
     disabled: boolean;
-    selectionChange: EventEmitter<any>;
+    /**
+     * Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity.
+     * @group Props
+     */
     trackBy: Function;
+    /**
+     * A list of values that are currently selected.
+     * @group Props
+     */
+    set selection(val: any[]);
+    get selection(): any[];
+    /**
+     * Value of the component.
+     * @group Props
+     */
+    set value(val: any[] | undefined);
+    get value(): any[] | undefined;
+    /**
+     * Callback to invoke on selection change.
+     * @param {*} any - selection instance.
+     * @group Emits
+     */
+    selectionChange: EventEmitter<any>;
+    /**
+     * Callback to invoke when list is reordered.
+     * @param {*} any - list instance.
+     * @group Emits
+     */
     onReorder: EventEmitter<any>;
-    onSelectionChange: EventEmitter<any>;
-    onFilterEvent: EventEmitter<any>;
-    listViewChild: ElementRef;
-    filterViewChild: ElementRef;
-    templates: QueryList<any>;
-    itemTemplate: TemplateRef<any>;
-    headerTemplate: TemplateRef<any>;
-    emptyMessageTemplate: TemplateRef<any>;
-    emptyFilterMessageTemplate: TemplateRef<any>;
-    filterTemplate: TemplateRef<any>;
-    moveUpIconTemplate: TemplateRef<any>;
-    moveTopIconTemplate: TemplateRef<any>;
-    moveDownIconTemplate: TemplateRef<any>;
-    moveBottomIconTemplate: TemplateRef<any>;
-    filterIconTemplate: TemplateRef<any>;
-    filterOptions: OrderListFilterOptions;
+    /**
+     * Callback to invoke when selection changes.
+     * @param {OrderListSelectionChangeEvent} event - Custom change event.
+     * @group Emits
+     */
+    onSelectionChange: EventEmitter<OrderListSelectionChangeEvent>;
+    /**
+     * Callback to invoke when filtering occurs.
+     * @param {OrderListFilterEvent} event - Custom filter event.
+     * @group Emits
+     */
+    onFilterEvent: EventEmitter<OrderListFilterEvent>;
+    listViewChild: Nullable<ElementRef>;
+    filterViewChild: Nullable<ElementRef>;
+    templates: Nullable<QueryList<PrimeTemplate>>;
+    itemTemplate: Nullable<TemplateRef<any>>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    emptyMessageTemplate: Nullable<TemplateRef<any>>;
+    emptyFilterMessageTemplate: Nullable<TemplateRef<any>>;
+    filterTemplate: Nullable<TemplateRef<any>>;
+    moveUpIconTemplate: Nullable<TemplateRef<any>>;
+    moveTopIconTemplate: Nullable<TemplateRef<any>>;
+    moveDownIconTemplate: Nullable<TemplateRef<any>>;
+    moveBottomIconTemplate: Nullable<TemplateRef<any>>;
+    filterIconTemplate: Nullable<TemplateRef<any>>;
+    filterOptions: Nullable<OrderListFilterOptions>;
     _selection: any[];
-    movedUp: boolean;
-    movedDown: boolean;
-    itemTouched: boolean;
+    movedUp: Nullable<boolean>;
+    movedDown: Nullable<boolean>;
+    itemTouched: Nullable<boolean>;
     styleElement: any;
     id: string;
-    filterValue: string;
-    visibleOptions: any[];
-    _value: any[];
+    filterValue: Nullable<string>;
+    visibleOptions: Nullable<any[]>;
+    _value: any[] | undefined;
     constructor(document: Document, platformId: any, renderer: Renderer2, el: ElementRef, cd: ChangeDetectorRef, filterService: FilterService);
-    get selection(): any[];
-    set selection(val: any[]);
     ngOnInit(): void;
     ngAfterContentInit(): void;
     ngAfterViewChecked(): void;
-    get value(): any[];
-    set value(val: any[]);
-    onItemClick(event: any, item: any, index: any): void;
-    onFilterKeyup(event: any): void;
+    onItemClick(event: Event, item: any, index: number): void;
+    onFilterKeyup(event: KeyboardEvent): void;
     filter(): void;
+    /**
+     * Callback to invoke on filter reset.
+     * @group Method
+     */
     resetFilter(): void;
-    isItemVisible(item: any): boolean;
+    isItemVisible(item: any): boolean | undefined;
     onItemTouchEnd(): void;
     isSelected(item: any): boolean;
     isEmpty(): boolean;
@@ -88,9 +194,9 @@ export declare class OrderList implements AfterViewChecked, AfterContentInit {
     moveDown(): void;
     moveBottom(): void;
     onDrop(event: CdkDragDrop<string[]>): void;
-    onItemKeydown(event: KeyboardEvent, item: any, index: Number): void;
-    findNextItem(item: any): any;
-    findPrevItem(item: any): any;
+    onItemKeydown(event: KeyboardEvent, item: any, index: number): void;
+    findNextItem(item: any): HTMLElement | null;
+    findPrevItem(item: any): HTMLElement | null;
     moveDisabled(): boolean;
     createStyle(): void;
     destroyStyle(): void;

package/orderlist/orderlist.interface.d.ts

@@ -0,0 +1,110 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Callbacks to invoke on filter.
+ * @group Interface
+ */
+export interface OrderListFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link OrderList.selectionChange}
+ * @group Events
+ */
+export interface OrderListSelectionChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Current selected values.
+     */
+    value: any[];
+}
+/**
+ * Custom change event.
+ * @see {@link OrderList.selectionChange}
+ * @group Events
+ */
+export interface OrderListFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filtered options.
+     */
+    value: any[];
+}
+/**
+ * Defines valid templates in OrderList.
+ * @group Templates
+ */
+export 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>;
+}

package/orderlist/public_api.d.ts

@@ -1 +1,2 @@
 export * from './orderlist';
+export * from './orderlist.interface';

package/organizationchart/organizationchart.d.ts

@@ -1,6 +1,9 @@
 import { ElementRef, AfterContentInit, EventEmitter, TemplateRef, QueryList, ChangeDetectorRef, OnDestroy } from '@angular/core';
 import { TreeNode } from 'primeng/api';
+import { PrimeTemplate } from 'primeng/api';
 import { Subscription } from 'rxjs';
+import { OrganizationChartNodeCollapseEvent, OrganizationChartNodeExpandEvent, OrganizationChartNodeSelectEvent, OrganizationChartNodeUnSelectEvent } from './organizationchart.interface';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/icons/chevrondown";
@@ -8,14 +11,14 @@ import * as i3 from "primeng/icons/chevronup";
 import * as i4 from "primeng/api";
 export declare class OrganizationChartNode implements OnDestroy {
     cd: ChangeDetectorRef;
-    node: TreeNode;
-    root: boolean;
-    first: boolean;
-    last: boolean;
+    node: TreeNode | undefined;
+    root: boolean | undefined;
+    first: boolean | undefined;
+    last: boolean | undefined;
     chart: OrganizationChart;
     subscription: Subscription;
-    constructor(chart: any, cd: ChangeDetectorRef);
-    get leaf(): boolean;
+    constructor(chart: OrganizationChart, cd: ChangeDetectorRef);
+    get leaf(): boolean | undefined;
     get colspan(): number;
     onNodeClick(event: Event, node: TreeNode): void;
     toggleNode(event: Event, node: TreeNode): void;
@@ -24,32 +27,87 @@ export declare class OrganizationChartNode implements OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<OrganizationChartNode, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<OrganizationChartNode, "[pOrganizationChartNode]", never, { "node": { "alias": "node"; "required": false; }; "root": { "alias": "root"; "required": false; }; "first": { "alias": "first"; "required": false; }; "last": { "alias": "last"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * OrganizationChart visualizes hierarchical organization data.
+ * @group Components
+ */
 export declare class OrganizationChart implements AfterContentInit {
     el: ElementRef;
     cd: ChangeDetectorRef;
-    value: TreeNode[];
-    style: any;
-    styleClass: string;
-    selectionMode: string;
+    /**
+     * An array of nested TreeNodes.
+     * @group Props
+     */
+    value: TreeNode[] | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Defines the selection mode.
+     * @group Props
+     */
+    selectionMode: 'single' | 'multiple' | null | undefined;
+    /**
+     * Whether the space allocated by a node is preserved when hidden.
+     * @group Props
+     */
     preserveSpace: boolean;
+    /**
+     * A single treenode instance or an array to refer to the selections.
+     * @group Props
+     */
     get selection(): any;
     set selection(val: any);
+    /**
+     * Callback to invoke on selection change.
+     * @param {*} any - selected value.
+     * @group Emits
+     */
     selectionChange: EventEmitter<any>;
-    onNodeSelect: EventEmitter<any>;
-    onNodeUnselect: EventEmitter<any>;
-    onNodeExpand: EventEmitter<any>;
-    onNodeCollapse: EventEmitter<any>;
-    templates: QueryList<any>;
+    /**
+     * Callback to invoke when a node is selected.
+     * @param {OrganizationChartNodeSelectEvent} event - custom node select event.
+     * @group Emits
+     */
+    onNodeSelect: EventEmitter<OrganizationChartNodeSelectEvent>;
+    /**
+     * Callback to invoke when a node is unselected.
+     * @param {OrganizationChartNodeUnSelectEvent} event - custom node unselect event.
+     * @group Emits
+     */
+    onNodeUnselect: EventEmitter<OrganizationChartNodeUnSelectEvent>;
+    /**
+     * Callback to invoke when a node is expanded.
+     * @param {OrganizationChartNodeExpandEvent} event - custom node expand event.
+     * @group Emits
+     */
+    onNodeExpand: EventEmitter<OrganizationChartNodeExpandEvent>;
+    /**
+     * Callback to invoke when a node is collapsed.
+     * @param {OrganizationChartNodeCollapseEvent} event - custom node collapse event.
+     * @group Emits
+     */
+    onNodeCollapse: EventEmitter<OrganizationChartNodeCollapseEvent>;
+    templates: Nullable<QueryList<PrimeTemplate>>;
     templateMap: any;
-    togglerIconTemplate: TemplateRef<any>;
+    togglerIconTemplate: Nullable<TemplateRef<any>>;
     private selectionSource;
     _selection: any;
-    initialized: boolean;
+    initialized: Nullable<boolean>;
     selectionSource$: import("rxjs").Observable<any>;
     constructor(el: ElementRef, cd: ChangeDetectorRef);
-    get root(): TreeNode;
+    get root(): TreeNode | null;
     ngAfterContentInit(): void;
-    getTemplateForNode(node: TreeNode): TemplateRef<any>;
+    getTemplateForNode(node: TreeNode): TemplateRef<any> | null;
     onNodeClick(event: Event, node: TreeNode): void;
     findIndexInSelection(node: TreeNode): number;
     isSelected(node: TreeNode): boolean;