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

package/galleria/galleria.d.ts

@@ -1,6 +1,8 @@
-import { ElementRef, OnDestroy, EventEmitter, QueryList, TemplateRef, OnInit, OnChanges, AfterContentChecked, SimpleChanges, ChangeDetectorRef, AfterViewInit, KeyValueDiffers, DoCheck, Renderer2 } from '@angular/core';
-import { PrimeNGConfig } from 'primeng/api';
 import { AnimationEvent } from '@angular/animations';
+import { AfterContentChecked, AfterViewInit, ChangeDetectorRef, DoCheck, ElementRef, EventEmitter, KeyValueDiffers, OnChanges, OnDestroy, OnInit, QueryList, Renderer2, SimpleChanges, TemplateRef } from '@angular/core';
+import { PrimeNGConfig, PrimeTemplate } from 'primeng/api';
+import { VoidListener } from 'primeng/ts-helpers';
+import { GalleriaResponsiveOptions } from './galleria.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
@@ -15,55 +17,172 @@ export declare class Galleria implements OnChanges, OnDestroy {
     element: ElementRef;
     cd: ChangeDetectorRef;
     config: PrimeNGConfig;
+    /**
+     * Index of the first item.
+     * @group Props
+     */
     get activeIndex(): number;
     set activeIndex(activeIndex: number);
+    /**
+     * Whether to display the component on fullscreen.
+     * @group Props
+     */
     fullScreen: boolean;
-    id: string;
-    value: any[];
+    /**
+     * Unique identifier of the element.
+     * @group Props
+     */
+    id: string | undefined;
+    /**
+     * An array of objects to display.
+     * @group Props
+     */
+    value: any[] | undefined;
+    /**
+     * Number of items per page.
+     * @group Props
+     */
     numVisible: number;
-    responsiveOptions: any[];
+    /**
+     * An array of options for responsive design.
+     * @see GalleriaResponsiveOptions
+     * @group Props
+     */
+    responsiveOptions: GalleriaResponsiveOptions[] | undefined;
+    /**
+     * Whether to display navigation buttons in item section.
+     * @group Props
+     */
     showItemNavigators: boolean;
+    /**
+     * Whether to display navigation buttons in thumbnail container.
+     * @group Props
+     */
     showThumbnailNavigators: boolean;
+    /**
+     * Whether to display navigation buttons on item hover.
+     * @group Props
+     */
     showItemNavigatorsOnHover: boolean;
+    /**
+     * When enabled, item is changed on indicator hover.
+     * @group Props
+     */
     changeItemOnIndicatorHover: boolean;
+    /**
+     * Defines if scrolling would be infinite.
+     * @group Props
+     */
     circular: boolean;
+    /**
+     * Items are displayed with a slideshow in autoPlay mode.
+     * @group Props
+     */
     autoPlay: boolean;
+    /**
+     * Time in milliseconds to scroll items.
+     * @group Props
+     */
     transitionInterval: number;
+    /**
+     * Whether to display thumbnail container.
+     * @group Props
+     */
     showThumbnails: boolean;
-    thumbnailsPosition: string;
+    /**
+     * Position of thumbnails.
+     * @group Props
+     */
+    thumbnailsPosition: 'bottom' | 'top' | 'left' | 'right' | undefined;
+    /**
+     * Height of the viewport in vertical thumbnail.
+     * @group Props
+     */
     verticalThumbnailViewPortHeight: string;
+    /**
+     * Whether to display indicator container.
+     * @group Props
+     */
     showIndicators: boolean;
+    /**
+     * When enabled, indicator container is displayed on item container.
+     * @group Props
+     */
     showIndicatorsOnItem: boolean;
-    indicatorsPosition: string;
+    /**
+     * Position of indicators.
+     * @group Props
+     */
+    indicatorsPosition: 'bottom' | 'top' | 'left' | 'right' | undefined;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
-    maskClass: string;
-    containerClass: string;
-    containerStyle: any;
+    /**
+     * Style class of the mask on fullscreen mode.
+     * @group Props
+     */
+    maskClass: string | undefined;
+    /**
+     * Style class of the component on fullscreen mode. Otherwise, the 'class' property can be used.
+     * @group Props
+     */
+    containerClass: string | undefined;
+    /**
+     * Inline style of the component on fullscreen mode. Otherwise, the 'style' property can be used.
+     * @group Props
+     */
+    containerStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
-    mask: ElementRef;
+    /**
+     * Specifies the visibility of the mask on fullscreen mode.
+     * @group Props
+     */
     get visible(): boolean;
     set visible(visible: boolean);
-    activeIndexChange: EventEmitter<any>;
-    visibleChange: EventEmitter<any>;
-    templates: QueryList<any>;
+    /**
+     * Callback to invoke on active index change.
+     * @param {number} number - active index.
+     * @group Emits
+     */
+    activeIndexChange: EventEmitter<number>;
+    /**
+     * Callback to invoke on visiblity change.
+     * @param {boolean} boolean - visible value.
+     * @group Emits
+     */
+    visibleChange: EventEmitter<boolean>;
+    mask: ElementRef | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
     _visible: boolean;
     _activeIndex: number;
     headerFacet: any;
     footerFacet: any;
     indicatorFacet: any;
     captionFacet: any;
-    closeIconTemplate: TemplateRef<any>;
-    previousThumbnailIconTemplate: TemplateRef<any>;
-    nextThumbnailIconTemplate: TemplateRef<any>;
-    itemPreviousIconTemplate: TemplateRef<any>;
-    itemNextIconTemplate: TemplateRef<any>;
+    closeIconTemplate: TemplateRef<any> | undefined;
+    previousThumbnailIconTemplate: TemplateRef<any> | undefined;
+    nextThumbnailIconTemplate: TemplateRef<any> | undefined;
+    itemPreviousIconTemplate: TemplateRef<any> | undefined;
+    itemNextIconTemplate: TemplateRef<any> | undefined;
     maskVisible: boolean;
     constructor(document: Document, element: ElementRef, cd: ChangeDetectorRef, config: PrimeNGConfig);
     ngAfterContentInit(): void;
     ngOnChanges(simpleChanges: SimpleChanges): void;
     onMaskHide(): void;
-    onActiveItemChange(index: any): void;
+    onActiveItemChange(index: number): void;
     onAnimationStart(event: AnimationEvent): void;
     onAnimationEnd(event: AnimationEvent): void;
     enableModality(): void;
@@ -79,33 +198,33 @@ export declare class GalleriaContent implements DoCheck {
     get activeIndex(): number;
     set activeIndex(activeIndex: number);
     value: any[];
-    numVisible: number;
-    maskHide: EventEmitter<any>;
-    activeItemChange: EventEmitter<any>;
+    numVisible: number | undefined;
+    maskHide: EventEmitter<boolean>;
+    activeItemChange: EventEmitter<number>;
     id: string;
     _activeIndex: number;
     slideShowActive: boolean;
     interval: any;
-    styleClass: string;
+    styleClass: string | undefined;
     private differ;
     constructor(galleria: Galleria, cd: ChangeDetectorRef, differs: KeyValueDiffers);
     ngDoCheck(): void;
     galleriaClass(): string;
     startSlideShow(): void;
     stopSlideShow(): void;
-    getPositionClass(preClassName: any, position: any): string;
+    getPositionClass(preClassName: string, position: string): string;
     isVertical(): boolean;
-    onActiveIndexChange(index: any): void;
+    onActiveIndexChange(index: number): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GalleriaContent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<GalleriaContent, "p-galleriaContent", never, { "activeIndex": { "alias": "activeIndex"; "required": false; }; "value": { "alias": "value"; "required": false; }; "numVisible": { "alias": "numVisible"; "required": false; }; }, { "maskHide": "maskHide"; "activeItemChange": "activeItemChange"; }, never, never, false, never>;
 }
 export declare class GalleriaItemSlot {
-    templates: QueryList<any>;
-    index: number;
+    templates: QueryList<PrimeTemplate> | undefined;
+    index: number | undefined;
     get item(): any;
     set item(item: any);
-    type: string;
-    contentTemplate: TemplateRef<any>;
+    type: string | undefined;
+    contentTemplate: TemplateRef<any> | undefined;
     context: any;
     _item: any;
     ngAfterContentInit(): void;
@@ -115,18 +234,18 @@ export declare class GalleriaItemSlot {
 export declare class GalleriaItem implements OnChanges {
     galleria: Galleria;
     circular: boolean;
-    value: any[];
+    value: any[] | undefined;
     showItemNavigators: boolean;
     showIndicators: boolean;
     slideShowActive: boolean;
     changeItemOnIndicatorHover: boolean;
     autoPlay: boolean;
-    templates: QueryList<any>;
+    templates: QueryList<PrimeTemplate> | undefined;
     indicatorFacet: any;
     captionFacet: any;
-    startSlideShow: EventEmitter<any>;
-    stopSlideShow: EventEmitter<any>;
-    onActiveIndexChange: EventEmitter<any>;
+    startSlideShow: EventEmitter<Event>;
+    stopSlideShow: EventEmitter<Event>;
+    onActiveIndexChange: EventEmitter<number>;
     get activeIndex(): number;
     set activeIndex(activeIndex: number);
     get activeItem(): any;
@@ -136,14 +255,14 @@ export declare class GalleriaItem implements OnChanges {
     next(): void;
     prev(): void;
     stopTheSlideShow(): void;
-    navForward(e: any): void;
-    navBackward(e: any): void;
-    onIndicatorClick(index: any): void;
-    onIndicatorMouseEnter(index: any): void;
-    onIndicatorKeyDown(index: any): void;
+    navForward(e: MouseEvent): void;
+    navBackward(e: MouseEvent): void;
+    onIndicatorClick(index: number): void;
+    onIndicatorMouseEnter(index: number): void;
+    onIndicatorKeyDown(index: number): void;
     isNavForwardDisabled(): boolean;
     isNavBackwardDisabled(): boolean;
-    isIndicatorItemActive(index: any): boolean;
+    isIndicatorItemActive(index: number): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<GalleriaItem, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<GalleriaItem, "p-galleriaItem", never, { "circular": { "alias": "circular"; "required": false; }; "value": { "alias": "value"; "required": false; }; "showItemNavigators": { "alias": "showItemNavigators"; "required": false; }; "showIndicators": { "alias": "showIndicators"; "required": false; }; "slideShowActive": { "alias": "slideShowActive"; "required": false; }; "changeItemOnIndicatorHover": { "alias": "changeItemOnIndicatorHover"; "required": false; }; "autoPlay": { "alias": "autoPlay"; "required": false; }; "templates": { "alias": "templates"; "required": false; }; "indicatorFacet": { "alias": "indicatorFacet"; "required": false; }; "captionFacet": { "alias": "captionFacet"; "required": false; }; "activeIndex": { "alias": "activeIndex"; "required": false; }; }, { "startSlideShow": "startSlideShow"; "stopSlideShow": "stopSlideShow"; "onActiveIndexChange": "onActiveIndexChange"; }, never, never, false, never>;
 }
@@ -153,29 +272,32 @@ export declare class GalleriaThumbnails implements OnInit, AfterContentChecked,
     private platformId;
     private renderer;
     private cd;
-    containerId: string;
-    value: any[];
+    containerId: string | undefined;
+    value: any[] | undefined;
     isVertical: boolean;
     slideShowActive: boolean;
     circular: boolean;
-    responsiveOptions: any[];
+    responsiveOptions: GalleriaResponsiveOptions[] | undefined;
     contentHeight: string;
     showThumbnailNavigators: boolean;
-    templates: QueryList<any>;
-    onActiveIndexChange: EventEmitter<any>;
-    stopSlideShow: EventEmitter<any>;
-    itemsContainer: ElementRef;
+    templates: QueryList<PrimeTemplate> | undefined;
+    onActiveIndexChange: EventEmitter<number>;
+    stopSlideShow: EventEmitter<Event>;
+    itemsContainer: ElementRef | undefined;
     get numVisible(): number;
     set numVisible(numVisible: number);
     get activeIndex(): number;
     set activeIndex(activeIndex: number);
-    index: number;
-    startPos: any;
-    thumbnailsStyle: any;
-    sortedResponsiveOptions: any;
+    index: number | undefined;
+    startPos: {
+        x: number;
+        y: number;
+    } | null;
+    thumbnailsStyle: HTMLStyleElement | null;
+    sortedResponsiveOptions: GalleriaResponsiveOptions[] | null;
     totalShiftedItems: number;
     page: number;
-    documentResizeListener: () => void | null;
+    documentResizeListener: VoidListener;
     _numVisible: number;
     d_numVisible: number;
     _oldNumVisible: number;
@@ -187,24 +309,24 @@ export declare class GalleriaThumbnails implements OnInit, AfterContentChecked,
     ngAfterViewInit(): void;
     createStyle(): void;
     calculatePosition(): void;
-    getTabIndex(index: any): number;
-    navForward(e: any): void;
-    navBackward(e: any): void;
-    onItemClick(index: any): void;
-    step(dir: any): void;
+    getTabIndex(index: number): number;
+    navForward(e: TouchEvent | MouseEvent): void;
+    navBackward(e: TouchEvent | MouseEvent): void;
+    onItemClick(index: number): void;
+    step(dir: number): void;
     stopTheSlideShow(): void;
-    changePageOnTouch(e: any, diff: any): void;
+    changePageOnTouch(e: TouchEvent, diff: number): void;
     getTotalPageNumber(): number;
     getMedianItemIndex(): number;
     onTransitionEnd(): void;
-    onTouchEnd(e: any): void;
-    onTouchMove(e: any): void;
-    onTouchStart(e: any): void;
+    onTouchEnd(e: TouchEvent): void;
+    onTouchMove(e: TouchEvent): void;
+    onTouchStart(e: TouchEvent): void;
     isNavBackwardDisabled(): boolean;
     isNavForwardDisabled(): boolean;
     firstItemAciveIndex(): number;
     lastItemActiveIndex(): number;
-    isItemActive(index: any): boolean;
+    isItemActive(index: number): boolean;
     bindDocumentListeners(): void;
     unbindDocumentListeners(): void;
     ngOnDestroy(): void;

package/galleria/galleria.interface.d.ts

@@ -0,0 +1,96 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Responsive options of the component.
+ */
+export interface GalleriaResponsiveOptions {
+    /**
+     * Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
+     */
+    breakpoint: string;
+    /**
+     * The number of visible items on breakpoint.
+     */
+    numVisible: number;
+}
+/**
+ * Defines valid templates in Galleria.
+ * @group Templates
+ */
+export interface GalleriaTemplates {
+    /**
+     * Custom template of header.
+     */
+    header: TemplateRef<any> | null;
+    /**
+     * Custom template of footer.
+     */
+    footer: TemplateRef<any> | null;
+    /**
+     * Custom template of indicator.
+     * @param {Object} context - indicator data.
+     */
+    indicator(context: {
+        /**
+         * Index of the item.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of closeicon.
+     */
+    closeicon: TemplateRef<any> | null;
+    /**
+     * Custom template of itemnexticon.
+     */
+    itemnexticon: TemplateRef<any> | null;
+    /**
+     * Custom template of itempreviousicon.
+     */
+    itempreviousicon: TemplateRef<any> | null;
+    /**
+     * Custom template of previousthumbnailicon.
+     */
+    previousthumbnailicon: TemplateRef<any> | null;
+    /**
+     * Custom template of nextthumbnailicon.
+     */
+    nextthumbnailicon: TemplateRef<any> | null;
+    /**
+     * Custom template of caption.
+     * @param {Object} context - item data.
+     */
+    caption(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of thumbnail.
+     * @param {Object} context - item data.
+     */
+    thumbnail(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of item.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+}

package/galleria/public_api.d.ts

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

package/image/image.d.ts

@@ -1,7 +1,8 @@
-import { ElementRef, TemplateRef, AfterContentInit, QueryList, EventEmitter, ChangeDetectorRef } from '@angular/core';
-import { PrimeNGConfig } from 'primeng/api';
 import { AnimationEvent } from '@angular/animations';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, QueryList, TemplateRef } from '@angular/core';
 import { SafeUrl } from '@angular/platform-browser';
+import { PrimeNGConfig, PrimeTemplate } from 'primeng/api';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
@@ -15,36 +16,101 @@ export declare class Image implements AfterContentInit {
     private document;
     private config;
     private cd;
-    imageClass: string;
-    imageStyle: any;
-    styleClass: string;
-    style: any;
-    src: string | SafeUrl;
-    alt: string;
-    width: string;
-    height: string;
-    appendTo: any;
+    /**
+     * Style class of the image element.
+     * @group Props
+     */
+    imageClass: string | undefined;
+    /**
+     * Inline style of the image element.
+     * @group Props
+     */
+    imageStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Attribute of the image element.
+     * @group Props
+     */
+    src: string | SafeUrl | undefined;
+    /**
+     * Attribute of the image element.
+     * @group Props
+     */
+    alt: string | undefined;
+    /**
+     * Attribute of the image element.
+     * @group Props
+     */
+    width: string | undefined;
+    /**
+     * Attribute of the image element.
+     * @group Props
+     */
+    height: string | undefined;
+    /**
+     * Target element to attach the dialog, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Controls the preview functionality.
+     * @group Props
+     */
     preview: boolean;
+    /**
+     * Transition options of the show animation
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation
+     * @group Props
+     */
     hideTransitionOptions: string;
+    /**
+     * Triggered when the preview overlay is shown.
+     * @group Emits
+     */
     onShow: EventEmitter<any>;
+    /**
+     * Triggered when the preview overlay is hidden.
+     * @group Emits
+     */
     onHide: EventEmitter<any>;
-    onImageError: EventEmitter<any>;
-    mask: ElementRef;
-    templates: QueryList<any>;
-    indicatorTemplate: TemplateRef<any>;
-    rotateRightIconTemplate: TemplateRef<any>;
-    rotateLeftIconTemplate: TemplateRef<any>;
-    zoomOutIconTemplate: TemplateRef<any>;
-    zoomInIconTemplate: TemplateRef<any>;
-    closeIconTemplate: TemplateRef<any>;
+    /**
+     * This event is triggered if an error occurs while loading an image file.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onImageError: EventEmitter<Event>;
+    mask: ElementRef | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    indicatorTemplate: TemplateRef<any> | undefined;
+    rotateRightIconTemplate: TemplateRef<any> | undefined;
+    rotateLeftIconTemplate: TemplateRef<any> | undefined;
+    zoomOutIconTemplate: TemplateRef<any> | undefined;
+    zoomInIconTemplate: TemplateRef<any> | undefined;
+    closeIconTemplate: TemplateRef<any> | undefined;
     maskVisible: boolean;
     previewVisible: boolean;
     rotate: number;
     scale: number;
     previewClick: boolean;
-    container: HTMLElement;
-    wrapper: HTMLElement;
+    container: Nullable<HTMLElement>;
+    wrapper: Nullable<HTMLElement>;
     get isZoomOutDisabled(): boolean;
     get isZoomInDisabled(): boolean;
     private zoomSettings;
@@ -70,7 +136,7 @@ export declare class Image implements AfterContentInit {
     };
     handleToolbarClick(event: MouseEvent): void;
     closePreview(): void;
-    imageError(event: any): void;
+    imageError(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<Image, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<Image, "p-image", never, { "imageClass": { "alias": "imageClass"; "required": false; }; "imageStyle": { "alias": "imageStyle"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "src": { "alias": "src"; "required": false; }; "alt": { "alias": "alt"; "required": false; }; "width": { "alias": "width"; "required": false; }; "height": { "alias": "height"; "required": false; }; "appendTo": { "alias": "appendTo"; "required": false; }; "preview": { "alias": "preview"; "required": false; }; "showTransitionOptions": { "alias": "showTransitionOptions"; "required": false; }; "hideTransitionOptions": { "alias": "hideTransitionOptions"; "required": false; }; }, { "onShow": "onShow"; "onHide": "onHide"; "onImageError": "onImageError"; }, ["templates"], never, false, never>;
 }

package/image/image.interface.d.ts

@@ -0,0 +1,31 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Image.
+ * @group Templates
+ */
+export interface ImageTemplates {
+    /**
+     * Custom template of indicator.
+     */
+    indicator: TemplateRef<any> | null;
+    /**
+     * Custom template of rotaterighticon.
+     */
+    rotaterighticon: TemplateRef<any> | null;
+    /**
+     * Custom template of rotatelefticon.
+     */
+    rotatelefticon: TemplateRef<any> | null;
+    /**
+     * Custom template of zoomouticon.
+     */
+    zoomouticon: TemplateRef<any> | null;
+    /**
+     * Custom template of zoominicon.
+     */
+    zoominicon: TemplateRef<any> | null;
+    /**
+     * Custom template of closeicon.
+     */
+    closeicon: TemplateRef<any> | null;
+}

package/image/public_api.d.ts

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