primeng 16.0.0-rc.1 → 16.0.0-rc.2

package/scroller/scroller.d.ts

@@ -1,110 +1,203 @@
 import { AfterContentInit, AfterViewChecked, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, QueryList, Renderer2, SimpleChanges, TemplateRef } from '@angular/core';
+import { PrimeTemplate } from 'primeng/api';
+import { ScrollerLazyLoadEvent, ScrollerOptions, ScrollerScrollEvent, ScrollerScrollIndexChangeEvent, ScrollerToType } from './scroller.interface';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
 import * as i3 from "primeng/icons/spinner";
-export type ScrollerToType = 'to-start' | 'to-end' | undefined;
-export type ScrollerOrientationType = 'vertical' | 'horizontal' | 'both';
-export interface ScrollerOptions {
-    id?: string | undefined;
-    style?: any;
-    styleClass?: string | undefined;
-    tabindex?: number | undefined;
-    items?: any[];
-    itemSize?: any;
-    scrollHeight?: string | undefined;
-    scrollWidth?: string | undefined;
-    orientation?: ScrollerOrientationType;
-    step?: number | undefined;
-    delay?: number | undefined;
-    resizeDelay?: number | undefined;
-    appendOnly?: boolean;
-    inline?: boolean;
-    lazy?: boolean;
-    disabled?: boolean;
-    loaderDisabled?: boolean;
-    columns?: any[] | undefined;
-    showSpacer?: boolean;
-    showLoader?: boolean;
-    numToleratedItems?: any;
-    loading?: boolean;
-    autoSize?: boolean;
-    trackBy?: any;
-    onLazyLoad?: Function | undefined;
-    onScroll?: Function | undefined;
-    onScrollIndexChange?: Function | undefined;
-}
 export declare class Scroller implements OnInit, AfterContentInit, AfterViewChecked, OnDestroy {
     private document;
     private platformId;
     private renderer;
     private cd;
     private zone;
-    get id(): string;
-    set id(val: string);
-    get style(): any;
-    set style(val: any);
-    get styleClass(): string;
-    set styleClass(val: string);
+    /**
+     * Unique identifier of the element.
+     * @group Props
+     */
+    get id(): string | undefined;
+    set id(val: string | undefined);
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    get style(): {
+        [klass: string]: any;
+    } | null | undefined;
+    set style(val: {
+        [klass: string]: any;
+    } | null | undefined);
+    /**
+     * Style class of the element.
+     * @group Props
+     */
+    get styleClass(): string | undefined;
+    set styleClass(val: string | undefined);
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
     get tabindex(): number;
     set tabindex(val: number);
-    get items(): any[];
-    set items(val: any[]);
-    get itemSize(): any;
-    set itemSize(val: any);
-    get scrollHeight(): string;
-    set scrollHeight(val: string);
-    get scrollWidth(): string;
-    set scrollWidth(val: string);
-    get orientation(): string;
-    set orientation(val: string);
+    /**
+     * An array of objects to display.
+     * @group Props
+     */
+    get items(): any[] | undefined | null;
+    set items(val: any[] | undefined | null);
+    /**
+     * The height/width of item according to orientation.
+     * @group Props
+     */
+    get itemSize(): number[] | number;
+    set itemSize(val: number[] | number);
+    /**
+     * Height of the scroll viewport.
+     * @group Props
+     */
+    get scrollHeight(): string | undefined;
+    set scrollHeight(val: string | undefined);
+    /**
+     * Width of the scroll viewport.
+     * @group Props
+     */
+    get scrollWidth(): string | undefined;
+    set scrollWidth(val: string | undefined);
+    /**
+     * The orientation of scrollbar.
+     * @group Props
+     */
+    get orientation(): 'vertical' | 'horizontal' | 'both';
+    set orientation(val: 'vertical' | 'horizontal' | 'both');
+    /**
+     * Used to specify how many items to load in each load method in lazy mode.
+     * @group Props
+     */
     get step(): number;
     set step(val: number);
+    /**
+     * Delay in scroll before new data is loaded.
+     * @group Props
+     */
     get delay(): number;
     set delay(val: number);
+    /**
+     * Delay after window's resize finishes.
+     * @group Props
+     */
     get resizeDelay(): number;
     set resizeDelay(val: number);
+    /**
+     * Used to append each loaded item to top without removing any items from the DOM. Using very large data may cause the browser to crash.
+     * @group Props
+     */
     get appendOnly(): boolean;
     set appendOnly(val: boolean);
+    /**
+     * Specifies whether the scroller should be displayed inline or not.
+     * @group Props
+     */
     get inline(): boolean;
     set inline(val: boolean);
+    /**
+     * Defines if data is loaded and interacted with in lazy manner.
+     * @group Props
+     */
     get lazy(): boolean;
     set lazy(val: boolean);
+    /**
+     * If disabled, the scroller feature is eliminated and the content is displayed directly.
+     * @group Props
+     */
     get disabled(): boolean;
     set disabled(val: boolean);
+    /**
+     * Used to implement a custom loader instead of using the loader feature in the scroller.
+     * @group Props
+     */
     get loaderDisabled(): boolean;
     set loaderDisabled(val: boolean);
-    get columns(): any[];
-    set columns(val: any[]);
+    /**
+     * Columns to display.
+     * @group Props
+     */
+    get columns(): any[] | undefined | null;
+    set columns(val: any[] | undefined | null);
+    /**
+     * Used to implement a custom spacer instead of using the spacer feature in the scroller.
+     * @group Props
+     */
     get showSpacer(): boolean;
     set showSpacer(val: boolean);
+    /**
+     * Defines whether to show loader.
+     * @group Props
+     */
     get showLoader(): boolean;
     set showLoader(val: boolean);
+    /**
+     * Determines how many additional elements to add to the DOM outside of the view. According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number. Default value is half the number of items shown in the view.
+     * @group Props
+     */
     get numToleratedItems(): number;
     set numToleratedItems(val: number);
-    get loading(): boolean;
-    set loading(val: boolean);
+    /**
+     * Defines whether the data is loaded.
+     * @group Props
+     */
+    get loading(): boolean | undefined;
+    set loading(val: boolean | undefined);
+    /**
+     * Defines whether to dynamically change the height or width of scrollable container.
+     * @group Props
+     */
     get autoSize(): boolean;
     set autoSize(val: boolean);
+    /**
+     * Function to optimize the dom operations by delegating to ngForTrackBy, default algoritm checks for object identity.
+     * @group Props
+     */
     get trackBy(): any;
     set trackBy(val: any);
-    get options(): ScrollerOptions;
-    set options(val: ScrollerOptions);
-    elementViewChild: ElementRef;
-    contentViewChild: ElementRef;
-    templates: QueryList<any>;
-    onLazyLoad: EventEmitter<any>;
-    onScroll: EventEmitter<any>;
-    onScrollIndexChange: EventEmitter<any>;
-    _id: string;
-    _style: any;
-    _styleClass: string;
+    /**
+     * Defines whether to use the scroller feature. The properties of scroller component can be used like an object in it.
+     * @group Props
+     */
+    get options(): ScrollerOptions | undefined;
+    set options(val: ScrollerOptions | undefined);
+    /**
+     * Callback to invoke in lazy mode to load new data.
+     * @param {ScrollerLazyLoadEvent} event - custom lazy load event.
+     * @group Emits
+     */
+    onLazyLoad: EventEmitter<ScrollerLazyLoadEvent>;
+    /**
+     * Callback to invoke when scroll position changes.
+     * @param {ScrollerScrollEvent} event - custom scroll event.
+     * @group Emits
+     */
+    onScroll: EventEmitter<ScrollerScrollEvent>;
+    /**
+     * Callback to invoke when scroll position and item's range in view changes.
+     * @param {ScrollerScrollEvent} event - custom scroll index change event.
+     * @group Emits
+     */
+    onScrollIndexChange: EventEmitter<ScrollerScrollIndexChangeEvent>;
+    elementViewChild: Nullable<ElementRef>;
+    contentViewChild: Nullable<ElementRef>;
+    templates: Nullable<QueryList<PrimeTemplate>>;
+    _id: string | undefined;
+    _style: {
+        [klass: string]: any;
+    } | null | undefined;
+    _styleClass: string | undefined;
     _tabindex: number;
-    _items: any[];
-    _itemSize: any;
-    _scrollHeight: string;
-    _scrollWidth: string;
-    _orientation: string;
+    _items: any[] | undefined | null;
+    _itemSize: number | number[];
+    _scrollHeight: string | undefined;
+    _scrollWidth: string | undefined;
+    _orientation: 'vertical' | 'horizontal' | 'both';
     _step: number;
     _delay: number;
     _resizeDelay: number;
@@ -113,21 +206,21 @@ export declare class Scroller implements OnInit, AfterContentInit, AfterViewChec
     _lazy: boolean;
     _disabled: boolean;
     _loaderDisabled: boolean;
-    _columns: any[];
+    _columns: any[] | undefined | null;
     _showSpacer: boolean;
     _showLoader: boolean;
     _numToleratedItems: any;
-    _loading: boolean;
+    _loading: boolean | undefined;
     _autoSize: boolean;
     _trackBy: any;
-    _options: ScrollerOptions;
+    _options: ScrollerOptions | undefined;
     d_loading: boolean;
     d_numToleratedItems: any;
     contentEl: any;
-    contentTemplate: TemplateRef<any>;
-    itemTemplate: TemplateRef<any>;
-    loaderTemplate: TemplateRef<any>;
-    loaderIconTemplate: TemplateRef<any>;
+    contentTemplate: Nullable<TemplateRef<any>>;
+    itemTemplate: Nullable<TemplateRef<any>>;
+    loaderTemplate: Nullable<TemplateRef<any>>;
+    loaderIconTemplate: Nullable<TemplateRef<any>>;
     first: any;
     last: any;
     page: number;
@@ -136,16 +229,20 @@ export declare class Scroller implements OnInit, AfterContentInit, AfterViewChec
     lastScrollPos: any;
     lazyLoadState: any;
     loaderArr: any[];
-    spacerStyle: any;
-    contentStyle: any;
+    spacerStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    contentStyle: {
+        [klass: string]: any;
+    } | null | undefined;
     scrollTimeout: any;
     resizeTimeout: any;
     initialized: boolean;
-    windowResizeListener: VoidFunction | null;
-    defaultWidth: number;
-    defaultHeight: number;
-    defaultContentWidth: number;
-    defaultContentHeight: number;
+    windowResizeListener: VoidListener;
+    defaultWidth: number | undefined;
+    defaultHeight: number | undefined;
+    defaultContentWidth: number | undefined;
+    defaultContentHeight: number | undefined;
     get vertical(): boolean;
     get horizontal(): boolean;
     get both(): boolean;
@@ -195,7 +292,7 @@ export declare class Scroller implements OnInit, AfterContentInit, AfterViewChec
     setSize(): void;
     setSpacerSize(): void;
     setContentPosition(pos: any): void;
-    onScrollPositionChange(event: any): {
+    onScrollPositionChange(event: Event): {
         first: number | {
             rows: number;
             cols: number;
@@ -204,16 +301,16 @@ export declare class Scroller implements OnInit, AfterContentInit, AfterViewChec
         isRangeChanged: boolean;
         scrollPos: any;
     };
-    onScrollChange(event: any): void;
-    onContainerScroll(event: any): void;
+    onScrollChange(event: Event): void;
+    onContainerScroll(event: Event): void;
     bindResizeListener(): void;
     unbindResizeListener(): void;
     onWindowResize(): void;
-    handleEvents(name: any, params: any): any;
+    handleEvents(name: string, params: any): any;
     getContentOptions(): {
         contentStyleClass: string;
         items: any[];
-        getItemOptions: (index: any) => {
+        getItemOptions: (index: number) => {
             index: any;
             count: number;
             first: boolean;
@@ -222,17 +319,21 @@ export declare class Scroller implements OnInit, AfterContentInit, AfterViewChec
             odd: boolean;
         };
         loading: boolean;
-        getLoaderOptions: (index: any, options?: any) => any;
-        itemSize: any;
+        getLoaderOptions: (index: number, options?: any) => any;
+        itemSize: number | number[];
         rows: any[];
         columns: any;
-        spacerStyle: any;
-        contentStyle: any;
+        spacerStyle: {
+            [klass: string]: any;
+        };
+        contentStyle: {
+            [klass: string]: any;
+        };
         vertical: boolean;
         horizontal: boolean;
         both: boolean;
     };
-    getOptions(renderedIndex: any): {
+    getOptions(renderedIndex: number): {
         index: any;
         count: number;
         first: boolean;
@@ -240,7 +341,7 @@ export declare class Scroller implements OnInit, AfterContentInit, AfterViewChec
         even: boolean;
         odd: boolean;
     };
-    getLoaderOptions(index: any, extOptions: any): any;
+    getLoaderOptions(index: number, extOptions: any): any;
     static ɵfac: i0.ɵɵFactoryDeclaration<Scroller, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<Scroller, "p-scroller", never, { "id": { "alias": "id"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "items": { "alias": "items"; "required": false; }; "itemSize": { "alias": "itemSize"; "required": false; }; "scrollHeight": { "alias": "scrollHeight"; "required": false; }; "scrollWidth": { "alias": "scrollWidth"; "required": false; }; "orientation": { "alias": "orientation"; "required": false; }; "step": { "alias": "step"; "required": false; }; "delay": { "alias": "delay"; "required": false; }; "resizeDelay": { "alias": "resizeDelay"; "required": false; }; "appendOnly": { "alias": "appendOnly"; "required": false; }; "inline": { "alias": "inline"; "required": false; }; "lazy": { "alias": "lazy"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "loaderDisabled": { "alias": "loaderDisabled"; "required": false; }; "columns": { "alias": "columns"; "required": false; }; "showSpacer": { "alias": "showSpacer"; "required": false; }; "showLoader": { "alias": "showLoader"; "required": false; }; "numToleratedItems": { "alias": "numToleratedItems"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; "autoSize": { "alias": "autoSize"; "required": false; }; "trackBy": { "alias": "trackBy"; "required": false; }; "options": { "alias": "options"; "required": false; }; }, { "onLazyLoad": "onLazyLoad"; "onScroll": "onScroll"; "onScrollIndexChange": "onScrollIndexChange"; }, ["templates"], ["*"], false, never>;
 }

package/scroller/scroller.interface.d.ts

@@ -0,0 +1,166 @@
+import { TemplateRef } from '@angular/core';
+export type ScrollerToType = 'to-start' | 'to-end' | undefined;
+export type ScrollerOrientationType = 'vertical' | 'horizontal' | 'both';
+/**
+ * Options for the virtual scroller.
+ */
+export interface ScrollerOptions {
+    id?: string | undefined;
+    style?: any;
+    styleClass?: string | undefined;
+    tabindex?: number | undefined;
+    items?: any[];
+    itemSize?: any;
+    scrollHeight?: string | undefined;
+    scrollWidth?: string | undefined;
+    orientation?: ScrollerOrientationType;
+    step?: number | undefined;
+    delay?: number | undefined;
+    resizeDelay?: number | undefined;
+    appendOnly?: boolean;
+    inline?: boolean;
+    lazy?: boolean;
+    disabled?: boolean;
+    loaderDisabled?: boolean;
+    columns?: any[] | undefined;
+    showSpacer?: boolean;
+    showLoader?: boolean;
+    numToleratedItems?: any;
+    loading?: boolean;
+    autoSize?: boolean;
+    trackBy?: any;
+    onLazyLoad?: Function | undefined;
+    onScroll?: Function | undefined;
+    onScrollIndexChange?: Function | undefined;
+}
+/**
+ * Loader icon options.
+ */
+export interface ScrollerLoaderIconOptions {
+    [klass: string]: any;
+}
+/**
+ * Scroller content options.
+ */
+export interface ScrollerContentOptions {
+    contentStyleClass?: string;
+    items?: any[];
+    loading?: boolean;
+    itemSize?: number;
+    rows?: any[];
+    columns?: any[];
+    spacerStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    contentStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    vertical?: boolean;
+    horizontal?: boolean;
+    both?: boolean;
+    getItemOptions?: (index: number) => ScrollerItemOptions;
+    getLoaderOptions?: (index: number, options?: any) => ScrollerLoaderOptions;
+}
+/**
+ * Scroller item options.
+ */
+export interface ScrollerItemOptions {
+    index?: number;
+    count?: number;
+    first?: boolean;
+    last?: boolean;
+    even?: boolean;
+    odd?: boolean;
+}
+/**
+ * Loader settings.
+ * @extends {ScrollerItemOptions}
+ */
+export interface ScrollerLoaderOptions extends ScrollerItemOptions {
+    [klass: string]: any;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Scroller.onLazyLoad}
+ */
+export interface ScrollerLazyLoadEvent {
+    /**
+     * First element index in viewport.
+     */
+    first: number;
+    /**
+     * Last element index in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom scroll index change event.
+ * @see {@link Scroller.onScrollIndexChange}
+ * @extends {ScrollerLazyLoadEvent}
+ */
+export interface ScrollerScrollIndexChangeEvent extends ScrollerLazyLoadEvent {
+}
+/**
+ * Custom scroll event.
+ * @see {@link Scroller.onScroll}
+ */
+export interface ScrollerScrollEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Defines valid templates in Scroller.
+ * @group Templates
+ */
+export interface ScrollerTemplates {
+    /**
+     * Custom content template.
+     */
+    content(context: {
+        /**
+         * Loaded items.
+         */
+        $implicit: any[] | any | null | undefined;
+        /**
+         *
+         */
+        options: ScrollerContentOptions;
+    }): TemplateRef<{
+        $implicit: any[] | any | null | undefined;
+        options: ScrollerContentOptions;
+    }>;
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+        /**
+         * Scroller item options.
+         */
+        options: ScrollerItemOptions;
+    }): TemplateRef<{
+        $implicit: any;
+        options: ScrollerItemOptions;
+    }>;
+    /**
+     * Custom loader template.
+     */
+    loader(context: {
+        options: ScrollerLoaderOptions;
+    }): TemplateRef<{
+        options: ScrollerLoaderOptions;
+    }>;
+    /**
+     * Custom loader icon template.
+     */
+    loadericon(context: {
+        options: ScrollerLoaderIconOptions;
+    }): TemplateRef<{
+        options: ScrollerLoaderIconOptions;
+    }>;
+}

package/scrollpanel/public_api.d.ts

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

package/scrollpanel/scrollpanel.d.ts

@@ -1,4 +1,5 @@
-import { AfterViewInit, OnDestroy, ElementRef, NgZone, ChangeDetectorRef, AfterContentInit, QueryList, TemplateRef, Renderer2 } from '@angular/core';
+import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, NgZone, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnDestroy {
@@ -8,29 +9,39 @@ export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnD
     cd: ChangeDetectorRef;
     private document;
     private renderer;
-    style: any;
-    styleClass: string;
-    containerViewChild: ElementRef;
-    contentViewChild: ElementRef;
-    xBarViewChild: ElementRef;
-    yBarViewChild: ElementRef;
-    templates: QueryList<any>;
-    scrollYRatio: number;
-    scrollXRatio: number;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    containerViewChild: ElementRef | undefined;
+    contentViewChild: ElementRef | undefined;
+    xBarViewChild: ElementRef | undefined;
+    yBarViewChild: ElementRef | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    scrollYRatio: number | undefined;
+    scrollXRatio: number | undefined;
     timeoutFrame: any;
     initialized: boolean;
-    lastPageY: number;
-    lastPageX: number;
+    lastPageY: number | undefined;
+    lastPageX: number | undefined;
     isXBarClicked: boolean;
     isYBarClicked: boolean;
-    contentTemplate: TemplateRef<any>;
-    windowResizeListener: VoidFunction | null;
-    contentScrollListener: VoidFunction | null;
-    mouseEnterListener: VoidFunction | null;
-    xBarMouseDownListener: VoidFunction | null;
-    yBarMouseDownListener: VoidFunction | null;
-    documentMouseMoveListener: VoidFunction | null;
-    documentMouseUpListener: VoidFunction | null;
+    contentTemplate: TemplateRef<any> | undefined;
+    windowResizeListener: VoidFunction | null | undefined;
+    contentScrollListener: VoidFunction | null | undefined;
+    mouseEnterListener: VoidFunction | null | undefined;
+    xBarMouseDownListener: VoidFunction | null | undefined;
+    yBarMouseDownListener: VoidFunction | null | undefined;
+    documentMouseMoveListener: VoidFunction | null | undefined;
+    documentMouseUpListener: VoidFunction | null | undefined;
     constructor(platformId: any, el: ElementRef, zone: NgZone, cd: ChangeDetectorRef, document: Document, renderer: Renderer2);
     ngAfterViewInit(): void;
     ngAfterContentInit(): void;
@@ -43,11 +54,20 @@ export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnD
     onDocumentMouseMove(e: MouseEvent): void;
     onMouseMoveForXBar(e: MouseEvent): void;
     onMouseMoveForYBar(e: MouseEvent): void;
+    /**
+     * Scrolls the top location to the given value.
+     * @param scrollTop
+     * @group Methods
+     */
     scrollTop(scrollTop: number): void;
     onDocumentMouseUp(e: Event): void;
-    requestAnimationFrame(f: Function): void;
+    requestAnimationFrame(f: VoidFunction): void;
     unbindListeners(): void;
     ngOnDestroy(): void;
+    /**
+     * Refreshes the position and size of the scrollbar.
+     * @group Methods
+     */
     refresh(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ScrollPanel, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ScrollPanel, "p-scrollPanel", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;

package/scrollpanel/scrollpanel.interface.d.ts

@@ -0,0 +1,11 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in ScrollPanel.
+ * @group Templates
+ */
+export interface ScrollPanelTemplates {
+    /**
+     * Custom content template.
+     */
+    content: TemplateRef<any> | null;
+}

package/scrolltop/public_api.d.ts

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