primeng 16.0.0-rc.1 → 16.0.0

package/slidemenu/slidemenu.d.ts

@@ -1,7 +1,8 @@
-import { ElementRef, AfterViewChecked, OnDestroy, Renderer2, EventEmitter, ChangeDetectorRef, QueryList, TemplateRef, AfterContentInit } from '@angular/core';
 import { AnimationEvent } from '@angular/animations';
+import { AfterContentInit, AfterViewChecked, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { MenuItem, OverlayService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { ConnectedOverlayScrollHandler } from 'primeng/dom';
-import { MenuItem, OverlayService, PrimeNGConfig } from 'primeng/api';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
@@ -14,27 +15,31 @@ export declare class SlideMenuSub implements OnDestroy {
     private document;
     private platformId;
     private renderer;
-    item: MenuItem;
-    root: boolean;
+    item: MenuItem | undefined;
+    root: boolean | undefined;
     backLabel: string;
-    menuWidth: number;
+    menuWidth: number | undefined;
     effectDuration: any;
     easing: string;
-    index: number;
-    sublistViewChild: ElementRef;
+    index: number | undefined;
+    sublistViewChild: ElementRef | undefined;
     slideMenu: SlideMenu;
-    transitionEndListener: VoidFunction | null;
-    constructor(slideMenu: any, document: Document, platformId: any, renderer: Renderer2);
+    transitionEndListener: VoidListener;
+    constructor(slideMenu: SlideMenu, document: Document, platformId: any, renderer: Renderer2);
     activeItem: any;
-    itemClick(event: any, item: MenuItem, listitem: any): void;
-    focusNextList(listitem: any): void;
-    onItemKeyDown(event: any): void;
+    itemClick(event: MouseEvent, item: MenuItem, listitem: any): void;
+    focusNextList(listitem: HTMLElement): void;
+    onItemKeyDown(event: KeyboardEvent): void;
     unbindTransitionEndListener(): void;
     ngOnDestroy(): void;
     get isActive(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<SlideMenuSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SlideMenuSub, "p-slideMenuSub", never, { "item": { "alias": "item"; "required": false; }; "root": { "alias": "root"; "required": false; }; "backLabel": { "alias": "backLabel"; "required": false; }; "menuWidth": { "alias": "menuWidth"; "required": false; }; "effectDuration": { "alias": "effectDuration"; "required": false; }; "easing": { "alias": "easing"; "required": false; }; "index": { "alias": "index"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * SlideMenu displays submenus with slide animation.
+ * @group Components
+ */
 export declare class SlideMenu implements AfterViewChecked, AfterContentInit, OnDestroy {
     private document;
     private platformId;
@@ -43,38 +48,104 @@ export declare class SlideMenu implements AfterViewChecked, AfterContentInit, On
     cd: ChangeDetectorRef;
     config: PrimeNGConfig;
     overlayService: OverlayService;
-    model: MenuItem[];
-    popup: boolean;
-    style: any;
-    styleClass: string;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Defines if menu would displayed as a popup.
+     * @group Props
+     */
+    popup: boolean | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Width of the submenus.
+     * @group Props
+     */
     menuWidth: number;
+    /**
+     * Height of the scrollable area, a scrollbar appears if a menu height is longer than this value.
+     * @group Props
+     */
     viewportHeight: number;
+    /**
+     * Duration of the sliding animation in milliseconds.
+     * @group Props
+     */
     effectDuration: any;
+    /**
+     * Easing animation to use for sliding.
+     * @group Props
+     */
     easing: string;
+    /**
+     * Label of element to navigate back.
+     * @group Props
+     */
     backLabel: string;
-    appendTo: any;
+    /**
+     * Target element to attach the overlay, 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;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
+    /**
+     * Callback to invoke when overlay menu is shown.
+     * @group Emits
+     */
     onShow: EventEmitter<any>;
+    /**
+     * Callback to invoke when overlay menu is hidden.
+     * @group Emits
+     */
     onHide: EventEmitter<any>;
-    templates: QueryList<any>;
-    containerViewChild: ElementRef;
-    backwardViewChild: ElementRef;
-    slideMenuContentViewChild: ElementRef;
-    documentClickListener: VoidFunction | null;
-    documentResizeListener: VoidFunction | null;
-    preventDocumentDefault: boolean;
-    scrollHandler: ConnectedOverlayScrollHandler | null;
+    templates: QueryList<PrimeTemplate> | undefined;
+    containerViewChild: ElementRef | undefined;
+    backwardViewChild: ElementRef | undefined;
+    slideMenuContentViewChild: ElementRef | undefined;
+    documentClickListener: VoidListener;
+    documentResizeListener: VoidListener;
+    preventDocumentDefault: boolean | undefined;
+    scrollHandler: Nullable<ConnectedOverlayScrollHandler>;
     left: number;
     animating: boolean;
     target: any;
-    visible: boolean;
-    viewportUpdated: boolean;
+    visible: boolean | undefined;
+    viewportUpdated: boolean | undefined;
     window: Window;
-    submenuIconTemplate: TemplateRef<any>;
-    backIconTemplate: TemplateRef<any>;
+    submenuIconTemplate: TemplateRef<any> | undefined;
+    backIconTemplate: TemplateRef<any> | undefined;
     constructor(document: Document, platformId: any, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, config: PrimeNGConfig, overlayService: OverlayService);
     ngAfterViewChecked(): void;
     ngAfterContentInit(): void;
@@ -82,18 +153,32 @@ export declare class SlideMenu implements AfterViewChecked, AfterContentInit, On
     set backward(element: ElementRef);
     set slideMenuContent(element: ElementRef);
     updateViewPort(): void;
-    toggle(event: any): void;
-    show(event: any): void;
-    onOverlayClick(event: any): void;
+    /**
+     * Toggles the visibility of the popup menu.
+     * @param {Event} event - Browser event.
+     * @group Method
+     */
+    toggle(event: Event): void;
+    /**
+     * Displays the popup menu.
+     * @param {Event} event - Browser event.
+     * @group Method
+     */
+    show(event: Event): void;
+    onOverlayClick(event: MouseEvent): void;
     onOverlayAnimationStart(event: AnimationEvent): void;
     onOverlayAnimationEnd(event: AnimationEvent): void;
     appendOverlay(): void;
     restoreOverlayAppend(): void;
     moveOnTop(): void;
+    /**
+     * Hides the popup menu.
+     * @group Method
+     */
     hide(): void;
     onWindowResize(): void;
     goBack(): void;
-    onBackwardKeydown(event: any): void;
+    onBackwardKeydown(event: KeyboardEvent): void;
     bindDocumentClickListener(): void;
     unbindDocumentClickListener(): void;
     bindDocumentResizeListener(): void;

package/slidemenu/slidemenu.interface.d.ts

@@ -0,0 +1,15 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in SlideMenu.
+ * @group Templates
+ */
+export interface SlideMenuTemplates {
+    /**
+     * Custom template of backicon.
+     */
+    backicon(): TemplateRef<any>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<any>;
+}

package/slider/public_api.d.ts

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

package/slider/slider.d.ts

@@ -1,8 +1,14 @@
 import { ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, Renderer2 } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
+import { SliderChangeEvent, SliderSlideEndEvent } from './slider.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare const SLIDER_VALUE_ACCESSOR: any;
+/**
+ * Slider is a component to provide input with a drag handle.
+ * @group Components
+ */
 export declare class Slider implements OnDestroy, ControlValueAccessor {
     private document;
     private platformId;
@@ -10,51 +16,107 @@ export declare class Slider implements OnDestroy, ControlValueAccessor {
     renderer: Renderer2;
     private ngZone;
     cd: ChangeDetectorRef;
-    animate: boolean;
-    disabled: boolean;
+    /**
+     * When enabled, displays an animation on click of the slider bar.
+     * @group Props
+     */
+    animate: boolean | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Mininum boundary value.
+     * @group Props
+     */
     min: number;
+    /**
+     * Maximum boundary value.
+     * @group Props
+     */
     max: number;
-    orientation: string;
-    step: number;
-    range: boolean;
-    style: any;
-    styleClass: string;
-    ariaLabelledBy: string;
+    /**
+     * Orientation of the slider.
+     * @group Props
+     */
+    orientation: 'horizontal' | 'vertical';
+    /**
+     * Step factor to increment/decrement the value.
+     * @group Props
+     */
+    step: number | undefined;
+    /**
+     * When specified, allows two boundary values to be picked.
+     * @group Props
+     */
+    range: boolean | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
+     * @group Props
+     */
+    ariaLabelledBy: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
     tabindex: number;
-    onChange: EventEmitter<any>;
-    onSlideEnd: EventEmitter<any>;
-    sliderHandle: ElementRef;
-    sliderHandleStart: ElementRef;
-    sliderHandleEnd: ElementRef;
-    value: number;
-    values: number[];
-    handleValue: number;
+    /**
+     * Callback to invoke on value change.
+     * @param {SliderChangeEvent} event - Custom value change event.
+     * @group Emits
+     */
+    onChange: EventEmitter<SliderChangeEvent>;
+    /**
+     * Callback to invoke when slide ended.
+     * @param {SliderSlideEndEvent} event - Custom slide end event.
+     * @group Emits
+     */
+    onSlideEnd: EventEmitter<SliderSlideEndEvent>;
+    sliderHandle: Nullable<ElementRef>;
+    sliderHandleStart: Nullable<ElementRef>;
+    sliderHandleEnd: Nullable<ElementRef>;
+    value: Nullable<number>;
+    values: Nullable<number[]>;
+    handleValue: Nullable<number>;
     handleValues: number[];
-    diff: number;
-    offset: number;
-    bottom: number;
+    diff: Nullable<number>;
+    offset: Nullable<number>;
+    bottom: Nullable<number>;
     onModelChange: Function;
     onModelTouched: Function;
-    dragging: boolean;
-    dragListener: VoidFunction | null;
-    mouseupListener: VoidFunction | null;
-    initX: number;
-    initY: number;
-    barWidth: number;
-    barHeight: number;
-    sliderHandleClick: boolean;
+    dragging: Nullable<boolean>;
+    dragListener: VoidListener;
+    mouseupListener: VoidListener;
+    initX: Nullable<number>;
+    initY: Nullable<number>;
+    barWidth: Nullable<number>;
+    barHeight: Nullable<number>;
+    sliderHandleClick: Nullable<boolean>;
     handleIndex: number;
     startHandleValue: any;
-    startx: number;
-    starty: number;
+    startx: Nullable<number>;
+    starty: Nullable<number>;
     constructor(document: Document, platformId: any, el: ElementRef, renderer: Renderer2, ngZone: NgZone, cd: ChangeDetectorRef);
-    onMouseDown(event: any, index?: number): void;
-    onTouchStart(event: any, index?: number): void;
-    onTouchMove(event: any, index?: number): void;
-    onTouchEnd(event: any, index?: number): void;
-    onBarClick(event: any): void;
-    onHandleKeydown(event: any, handleIndex?: number): void;
-    spin(event: any, dir: number, handleIndex?: number): void;
+    onMouseDown(event: Event, index?: number): void;
+    onTouchStart(event: TouchEvent, index?: number): void;
+    onTouchMove(event: TouchEvent): void;
+    onTouchEnd(event: TouchEvent): void;
+    onBarClick(event: Event): void;
+    onHandleKeydown(event: KeyboardEvent, handleIndex?: number): void;
+    spin(event: Event, dir: number, handleIndex?: number): void;
     handleChange(event: Event): void;
     bindDragListeners(): void;
     unbindDragListeners(): void;
@@ -70,7 +132,7 @@ export declare class Slider implements OnDestroy, ControlValueAccessor {
     get rangeEndBottom(): string;
     isVertical(): boolean;
     updateDomData(): void;
-    calculateHandleValue(event: any): number;
+    calculateHandleValue(event: Event): number;
     updateHandleValue(): void;
     updateDiffAndOffset(): void;
     getDiff(): number;

package/slider/slider.interface.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Custom change event.
+ * @see {@link Slider.onChange}
+ * @group Events
+ */
+export interface SliderChangeEvent {
+    /**
+     * Browser event.
+     */
+    event: Event;
+    /**
+     * New values.
+     */
+    values?: number[];
+    /**
+     * New value.
+     */
+    value?: number;
+}
+/**
+ * Custom slide end event.
+ * @see {@link Slider.onSlideEnd}
+ * @group Events
+ */
+export interface SliderSlideEndEvent {
+    /**
+     * Original event
+     */
+    originalEvent: Event;
+    /**
+     * New value.
+     */
+    value?: number;
+    /**
+     * New values.
+     */
+    values?: number[];
+}

package/speeddial/public_api.d.ts

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

package/speeddial/speeddial.d.ts

@@ -1,5 +1,5 @@
-import { ElementRef, TemplateRef, AfterContentInit, QueryList, EventEmitter, ChangeDetectorRef, OnDestroy, AfterViewInit, Renderer2 } from '@angular/core';
-import { MenuItem } from 'primeng/api';
+import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { MenuItem, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/button";
@@ -8,41 +8,153 @@ import * as i4 from "primeng/tooltip";
 import * as i5 from "@angular/router";
 import * as i6 from "primeng/icons/plus";
 import * as i7 from "primeng/api";
+/**
+ * When pressed, a floating action button can display multiple primary actions that can be performed on a page.
+ * @group Components
+ */
 export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDestroy {
     private platformId;
     private el;
     cd: ChangeDetectorRef;
     private document;
     private renderer;
-    id: string;
-    model: any[];
-    get visible(): any;
-    set visible(value: any);
-    style: any;
-    className: string;
-    direction: string;
+    /**
+     * List of items id.
+     * @group Props
+     */
+    id: string | undefined;
+    /**
+     * MenuModel instance to define the action items.
+     * @group Props
+     */
+    model: MenuItem[] | null;
+    /**
+     * Specifies the visibility of the overlay.
+     * @defaultValue false
+     * @group Props
+     */
+    get visible(): boolean;
+    set visible(value: boolean);
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the element.
+     * @group Props
+     */
+    className: string | undefined;
+    /**
+     * Specifies the opening direction of actions.
+     * @gruop Props
+     */
+    direction: 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right' | undefined;
+    /**
+     * Transition delay step for each action item.
+     * @group Props
+     */
     transitionDelay: number;
-    type: string;
+    /**
+     * Specifies the opening type of actions.
+     * @group Props
+     */
+    type: 'linear' | 'circle' | 'semi-circle' | 'quarter-circle' | undefined;
+    /**
+     * Radius for *circle types.
+     * @group Props
+     */
     radius: number;
+    /**
+     * Whether to show a mask element behind the speeddial.
+     * @group Props
+     */
     mask: boolean;
+    /**
+     * Whether the component is disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * Whether the actions close when clicked outside.
+     * @group Props
+     */
     hideOnClickOutside: boolean;
-    buttonStyle: any;
-    buttonClassName: string;
-    maskStyle: any;
-    maskClassName: string;
-    showIcon: string;
-    hideIcon: string;
+    /**
+     * Inline style of the button element.
+     * @group Props
+     */
+    buttonStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the button element.
+     * @group Props
+     */
+    buttonClassName: string | undefined;
+    /**
+     * Inline style of the mask element.
+     * @group Props
+     */
+    maskStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the mask element.
+     * @group Props
+     */
+    maskClassName: string | undefined;
+    /**
+     * Show icon of the button element.
+     * @group Props
+     */
+    showIcon: string | undefined;
+    /**
+     * Hide icon of the button element.
+     * @group Props
+     */
+    hideIcon: string | undefined;
+    /**
+     * Defined to rotate showIcon when hideIcon is not present.
+     * @group Props
+     */
     rotateAnimation: boolean;
-    onVisibleChange: EventEmitter<any>;
-    visibleChange: EventEmitter<any>;
-    onClick: EventEmitter<any>;
-    onShow: EventEmitter<any>;
-    onHide: EventEmitter<any>;
-    container: ElementRef;
-    list: ElementRef;
-    templates: QueryList<any>;
-    buttonTemplate: TemplateRef<any>;
+    /**
+     * Fired when the visibility of element changed.
+     * @param {boolean} boolean - Visibility value.
+     * @group Emits
+     */
+    onVisibleChange: EventEmitter<boolean>;
+    /**
+     * Fired when the visibility of element changed.
+     * @param {boolean} boolean - Visibility value.
+     * @group Emits
+     */
+    visibleChange: EventEmitter<boolean>;
+    /**
+     * Fired when the button element clicked.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Emits
+     */
+    onClick: EventEmitter<MouseEvent>;
+    /**
+     * Fired when the actions are visible.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onShow: EventEmitter<Event>;
+    /**
+     * Fired when the actions are hidden.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onHide: EventEmitter<Event>;
+    container: ElementRef | undefined;
+    list: ElementRef | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    buttonTemplate: TemplateRef<any> | undefined;
     isItemClicked: boolean;
     _visible: boolean;
     documentClickListener: any;
@@ -51,9 +163,9 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
     ngAfterContentInit(): void;
     show(): void;
     hide(): void;
-    onButtonClick(event: any): void;
-    onItemClick(e: any, item: any): void;
-    calculatePointStyle(index: any): {
+    onButtonClick(event: MouseEvent): void;
+    onItemClick(e: MouseEvent, item: MenuItem): void;
+    calculatePointStyle(index: number): {
         left: string;
         top: string;
         bottom?: undefined;
@@ -79,10 +191,10 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
         bottom?: undefined;
         right?: undefined;
     };
-    calculateTransitionDelay(index: any): number;
+    calculateTransitionDelay(index: number): number;
     containerClass(): {
-        [x: string]: any;
-        'p-speeddial-opened': any;
+        [x: string]: boolean;
+        'p-speeddial-opened': boolean;
         'p-disabled': boolean;
     };
     buttonClass(): {
@@ -91,7 +203,7 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
         'p-speeddial-rotate': boolean;
     };
     get buttonIconClass(): string;
-    getItemStyle(index: any): {
+    getItemStyle(index: number): {
         left: string;
         top: string;
         bottom?: undefined;
@@ -123,7 +235,7 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
         transitionDelay: string;
     };
     isClickableRouterLink(item: MenuItem): boolean;
-    isOutsideClicked(event: any): boolean;
+    isOutsideClicked(event: Event): boolean;
     bindDocumentClickListener(): void;
     unbindDocumentClickListener(): void;
     ngOnDestroy(): void;

package/speeddial/speeddial.interface.d.ts

@@ -0,0 +1,11 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in SpeedDial.
+ * @group Templates
+ */
+export interface SpeedDialTemplates {
+    /**
+     * Custom template of button.
+     */
+    button(): TemplateRef<any>;
+}

package/splitbutton/public_api.d.ts

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