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

package/calendar/calendar.interface.d.ts

@@ -0,0 +1,134 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Calendar.
+ * @group Templates
+ */
+export interface CalendarTemplates {
+    /**
+     * Custom header template.
+     * @param {Object} context - date value instance.
+     */
+    date(context: {
+        /**
+         * Date value of the component.
+         */
+        $implicit: Date;
+    }): TemplateRef<{
+        $implicit: Date;
+    }> | null;
+    /**
+     * Custom decade template
+     * @param {Object} context - date value instance.
+     */
+    decade(context: {
+        /**
+         * An array containing the start and and year of a decade to display at header of the year picker.
+         */
+        $implicit: Date;
+    }): TemplateRef<{
+        $implicit: Date;
+    }> | null;
+    /**
+     * Custom disabled date template.
+     */
+    disabledDate: TemplateRef<any> | null;
+    /**
+     * Custom header template.
+     */
+    header: TemplateRef<any> | null;
+    /**
+     * Custom previous icon template.
+     */
+    previousicon: TemplateRef<any> | null;
+    /**
+     * Custom next icon template.
+     */
+    nexticon: TemplateRef<any> | null;
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    triggericon: TemplateRef<any> | null;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon: TemplateRef<any> | null;
+    /**
+     * Custom decrement icon template.
+     */
+    decrementicon: TemplateRef<any> | null;
+    /**
+     * Custom increment icon template.
+     */
+    incrementicon: TemplateRef<any> | null;
+    /**
+     * Custom footer template.
+     */
+    footer: TemplateRef<any> | null;
+}
+/**
+ * Locale settings options.
+ */
+export interface LocaleSettings {
+    firstDayOfWeek?: number;
+    dayNames?: string[];
+    dayNamesShort?: string[];
+    dayNamesMin?: string[];
+    monthNames?: string[];
+    monthNamesShort?: string[];
+    today?: string;
+    clear?: string;
+    dateFormat?: string;
+    weekHeader?: string;
+}
+export interface Month {
+    month?: number;
+    year?: number;
+    dates?: Array<Date>;
+    weekNumbers?: number[];
+}
+/**
+ * Custom Calendar responsive options metadata.
+ */
+export interface CalendarResponsiveOptions {
+    /**
+     * Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
+     */
+    breakpoint?: string;
+    /**
+     * The number of visible months on breakpoint.
+     */
+    numMonths?: number;
+}
+export type CalendarTypeView = 'date' | 'month' | 'year';
+export type NavigationState = {
+    backward?: boolean;
+    button?: boolean;
+};
+/**
+ * Custom Calendar year change event.
+ * @see {@link Calendar.onYearChange}
+ */
+export interface CalendarYearChangeEvent {
+    /**
+     * New month.
+     */
+    month?: number;
+    /**
+     * New year.
+     */
+    year?: number;
+}
+/**
+ * Custom Calendar month change event.
+ * @see {@link Calendar.onMonthChange}
+ */
+export interface CalendarMonthChangeEvent {
+    /**
+     * New month.
+     */
+    month?: number;
+    /**
+     * New year.
+     */
+    year?: number;
+}

package/calendar/public_api.d.ts

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

package/card/card.d.ts

@@ -1,22 +1,40 @@
-import { ElementRef, TemplateRef, AfterContentInit, QueryList } from '@angular/core';
-import { BlockableUI } from 'primeng/api';
+import { AfterContentInit, ElementRef, QueryList, TemplateRef } from '@angular/core';
+import { BlockableUI, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
 export declare class Card implements AfterContentInit, BlockableUI {
     private el;
-    header: string;
-    subheader: string;
-    style: any;
-    styleClass: string;
-    headerFacet: any;
-    footerFacet: any;
-    templates: QueryList<any>;
-    headerTemplate: TemplateRef<any>;
-    titleTemplate: TemplateRef<any>;
-    subtitleTemplate: TemplateRef<any>;
-    contentTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
+    /**
+     * Header of the card.
+     * @group Props
+     */
+    header: string | undefined;
+    /**
+     * Subheader of the card.
+     * @group Props
+     */
+    subheader: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    headerFacet: TemplateRef<any> | undefined;
+    footerFacet: TemplateRef<any> | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    headerTemplate: TemplateRef<any> | undefined;
+    titleTemplate: TemplateRef<any> | undefined;
+    subtitleTemplate: TemplateRef<any> | undefined;
+    contentTemplate: TemplateRef<any> | undefined;
+    footerTemplate: TemplateRef<any> | undefined;
     constructor(el: ElementRef);
     ngAfterContentInit(): void;
     getBlockableElement(): HTMLElement;

package/card/card.interface.d.ts

@@ -0,0 +1,27 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Card.
+ * @group Templates
+ */
+export interface CardTemplates {
+    /**
+     * Custom template of header.
+     */
+    header: TemplateRef<any> | null;
+    /**
+     * Custom template of title.
+     */
+    title: TemplateRef<any> | null;
+    /**
+     * Custom template of subtitle.
+     */
+    subtitle: TemplateRef<any> | null;
+    /**
+     * Custom template of content.
+     */
+    content: TemplateRef<any> | null;
+    /**
+     * Custom template of footer.
+     */
+    footer: TemplateRef<any> | null;
+}

package/card/public_api.d.ts

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

package/carousel/carousel.d.ts

@@ -1,4 +1,6 @@
-import { ElementRef, AfterContentInit, TemplateRef, QueryList, NgZone, EventEmitter, ChangeDetectorRef, SimpleChanges, Renderer2 } from '@angular/core';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, QueryList, Renderer2, SimpleChanges, TemplateRef } from '@angular/core';
+import { Footer, Header, PrimeTemplate } from 'primeng/api';
+import { CarouselResponsiveOptions } from './carousel.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
@@ -14,33 +16,119 @@ export declare class Carousel implements AfterContentInit {
     private renderer;
     private document;
     private platformId;
+    /**
+     * Index of the first item.
+     * @group Props
+     */
     get page(): number;
     set page(val: number);
+    /**
+     * Number of items per page.
+     * @group Props
+     */
     get numVisible(): number;
     set numVisible(val: number);
+    /**
+     * Number of items to scroll.
+     * @group Props
+     */
     get numScroll(): number;
     set numScroll(val: number);
-    responsiveOptions: any[];
+    /**
+     * An array of options for responsive design.
+     * @see CarouselResponsiveOptions
+     * @group Props
+     */
+    responsiveOptions: CarouselResponsiveOptions[] | undefined;
+    /**
+     * Specifies the layout of the component, valid values are 'horizontal' and 'vertical'.
+     * @group Props
+     */
     orientation: string;
+    /**
+     * Height of the viewport in vertical layout.
+     * @group Props
+     */
     verticalViewPortHeight: string;
+    /**
+     * Style class of main content.
+     * @group Props
+     */
     contentClass: string;
+    /**
+     * Style class of the indicator items.
+     * @group Props
+     */
     indicatorsContentClass: string;
-    indicatorsContentStyle: any;
+    /**
+     * Inline style of the indicator items.
+     * @group Props
+     */
+    indicatorsContentStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the indicators.
+     * @group Props
+     */
     indicatorStyleClass: string;
-    indicatorStyle: any;
+    /**
+     * Style of the indicators.
+     * @group Props
+     */
+    indicatorStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * An array of objects to display.
+     * @group Props
+     */
     get value(): any[];
     set value(val: any[]);
+    /**
+     * Defines if scrolling would be infinite.
+     * @group Props
+     */
     circular: boolean;
+    /**
+     * Whether to display indicator container.
+     * @group Props
+     */
     showIndicators: boolean;
+    /**
+     * Whether to display navigation buttons in container.
+     * @group Props
+     */
     showNavigators: boolean;
+    /**
+     * Time in milliseconds to scroll items automatically.
+     * @group Props
+     */
     autoplayInterval: number;
-    style: any;
-    styleClass: string;
-    onPage: EventEmitter<any>;
-    itemsContainer: ElementRef;
-    headerFacet: any;
-    footerFacet: any;
-    templates: QueryList<any>;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the viewport container.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Callback to invoke after scroll.
+     * @param {Object} event - custom page event.
+     * @group Emits
+     */
+    onPage: EventEmitter<{
+        page: number;
+    }>;
+    itemsContainer: ElementRef | undefined;
+    headerFacet: QueryList<Header> | undefined;
+    footerFacet: QueryList<Footer> | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
     _numVisible: number;
     _numScroll: number;
     _oldNumScroll: number;
@@ -48,28 +136,28 @@ export declare class Carousel implements AfterContentInit {
     defaultNumScroll: number;
     defaultNumVisible: number;
     _page: number;
-    _value: any[];
+    _value: any[] | null | undefined;
     carouselStyle: any;
-    id: string;
+    id: string | undefined;
     totalShiftedItems: any;
     isRemainingItemsAdded: boolean;
     animationTimeout: any;
     translateTimeout: any;
     remainingItems: number;
-    _items: any[];
+    _items: any[] | undefined;
     startPos: any;
     documentResizeListener: any;
-    clonedItemsForStarting: any[];
-    clonedItemsForFinishing: any[];
-    allowAutoplay: boolean;
+    clonedItemsForStarting: any[] | undefined;
+    clonedItemsForFinishing: any[] | undefined;
+    allowAutoplay: boolean | undefined;
     interval: any;
-    isCreated: boolean;
+    isCreated: boolean | undefined;
     swipeThreshold: number;
-    itemTemplate: TemplateRef<any>;
-    headerTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    previousIconTemplate: TemplateRef<any>;
-    nextIconTemplate: TemplateRef<any>;
+    itemTemplate: TemplateRef<any> | undefined;
+    headerTemplate: TemplateRef<any> | undefined;
+    footerTemplate: TemplateRef<any> | undefined;
+    previousIconTemplate: TemplateRef<any> | undefined;
+    nextIconTemplate: TemplateRef<any> | undefined;
     window: Window;
     constructor(el: ElementRef, zone: NgZone, cd: ChangeDetectorRef, renderer: Renderer2, document: Document, platformId: any);
     ngOnChanges(simpleChange: SimpleChanges): void;
@@ -88,17 +176,17 @@ export declare class Carousel implements AfterContentInit {
     isForwardNavDisabled(): boolean;
     isBackwardNavDisabled(): boolean;
     isEmpty(): boolean;
-    navForward(e: any, index?: any): void;
-    navBackward(e: any, index?: any): void;
-    onDotClick(e: any, index: any): void;
-    step(dir: any, page: any): void;
+    navForward(e: MouseEvent | TouchEvent, index?: number): void;
+    navBackward(e: MouseEvent | TouchEvent, index?: number): void;
+    onDotClick(e: MouseEvent, index: number): void;
+    step(dir: number, page?: number): void;
     startAutoplay(): void;
     stopAutoplay(): void;
     onTransitionEnd(): void;
-    onTouchStart(e: any): void;
-    onTouchMove(e: any): void;
-    onTouchEnd(e: any): void;
-    changePageOnTouch(e: any, diff: any): void;
+    onTouchStart(e: TouchEvent): void;
+    onTouchMove(e: TouchEvent | MouseEvent): void;
+    onTouchEnd(e: TouchEvent): void;
+    changePageOnTouch(e: TouchEvent | MouseEvent, diff: number): void;
     bindDocumentListeners(): void;
     unbindDocumentListeners(): void;
     ngOnDestroy(): void;

package/carousel/carousel.interface.d.ts

@@ -0,0 +1,52 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Responsive options of the component.
+ */
+export interface CarouselResponsiveOptions {
+    /**
+     * Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
+     */
+    breakpoint: string;
+    /**
+     * The number of visible items on breakpoint.
+     */
+    numVisible: number;
+    /**
+     * The number of scrolled items on breakpoint.
+     */
+    numScroll: number;
+}
+/**
+ * Defines valid templates in Carousel.
+ * @group Templates
+ */
+export interface CarouselTemplates {
+    /**
+     * Custom template of header.
+     */
+    header: TemplateRef<any> | null;
+    /**
+     * Custom template of item.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Data of the item.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of previousicon.
+     */
+    previousicon: TemplateRef<any> | null;
+    /**
+     * Custom template of nexticon.
+     */
+    nexticon: TemplateRef<any> | null;
+    /**
+     * Custom template of footer.
+     */
+    footer: TemplateRef<any> | null;
+}

package/carousel/public_api.d.ts

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