primeng 16.0.0-rc.1 → 16.0.0

package/dropdown/dropdown.interface.d.ts

@@ -0,0 +1,154 @@
+import { TemplateRef } from '@angular/core';
+import { ScrollerOptions } from 'primeng/api';
+/**
+ * Filter callbacks of the dropdown.
+ * @group Interface
+ */
+export interface DropdownFilterOptions {
+    /**
+     * Filter function.
+     */
+    filter?: (value?: any) => void;
+    /**
+     * Reset function.
+     */
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link Dropdown.onChange}
+ * @group Events
+ */
+export interface DropdownChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value
+     */
+    value: any;
+}
+/**
+ * Custom filter event.
+ * @see {@link Dropdown.onFilter}
+ * @group Events
+ */
+export interface DropdownFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filter value.
+     */
+    filter: any;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Dropdown.onLazyLoad}
+ * @group Events
+ */
+export interface DropdownLazyLoadEvent {
+    /**
+     * Index of the first element in viewport.
+     */
+    first: number;
+    /**
+     * Index of the last element in viewport.
+     */
+    last: number;
+}
+/**
+ * Defines valid templates in Dropdown.
+ * @group Templates
+ */
+export interface DropdownTemplates {
+    /**
+     * 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 item data.
+     */
+    selectedItem(context: {
+        /**
+         * Selected option value.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom filter template.
+     * @param {DropdownFilterOptions} options - filter options.
+     */
+    filter(context: {
+        /**
+         * Filter options.
+         */
+        options: DropdownFilterOptions;
+    }): TemplateRef<{
+        options: DropdownFilterOptions;
+    }>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom empty filter template.
+     */
+    emptyfilter(): TemplateRef<any>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom group template.
+     */
+    group(context: {
+        /**
+         * Group option.
+         */
+        $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>;
+}

package/dropdown/public_api.d.ts

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

package/dynamicdialog/dialogservice.d.ts

@@ -3,6 +3,10 @@ import { DynamicDialogComponent } from './dynamicdialog';
 import { DynamicDialogConfig } from './dynamicdialog-config';
 import { DynamicDialogRef } from './dynamicdialog-ref';
 import * as i0 from "@angular/core";
+/**
+ * Dynamic Dialog component methods.
+ * @group Service
+ */
 export declare class DialogService {
     private componentFactoryResolver;
     private appRef;
@@ -10,6 +14,13 @@ export declare class DialogService {
     private document;
     dialogComponentRefMap: Map<DynamicDialogRef, ComponentRef<DynamicDialogComponent>>;
     constructor(componentFactoryResolver: ComponentFactoryResolver, appRef: ApplicationRef, injector: Injector, document: Document);
+    /**
+     * Displays the dialog using the dynamic dialog object options.
+     * @param {*} componentType - Dynamic component for content template.
+     * @param {DynamicDialogConfig} config - DynamicDialog object.
+     * @returns {DynamicDialogRef} DynamicDialog instance.
+     * @group Method
+     */
     open(componentType: Type<any>, config: DynamicDialogConfig): DynamicDialogRef;
     private appendDialogComponentToBody;
     private removeDialogComponentFromBody;

package/dynamicdialog/dynamicdialog-config.d.ts

@@ -1,29 +1,118 @@
+/**
+ * Dialogs can be created dynamically with any component as the content using a DialogService.
+ * @group Interface
+ */
 export declare class DynamicDialogConfig<T = any> {
+    /**
+     * An object to pass to the component loaded inside the Dialog.
+     */
     data?: T;
+    /**
+     * Header text of the dialog.
+     */
     header?: string;
+    /**
+     * Footer text of the dialog.
+     */
     footer?: string;
+    /**
+     * Width of the dialog.
+     */
     width?: string;
+    /**
+     * Height of the dialog.
+     */
     height?: string;
+    /**
+     * Specifies if pressing escape key should hide the dialog.
+     */
     closeOnEscape?: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     */
     baseZIndex?: number;
+    /**
+     * Whether to automatically manage layering.
+     */
     autoZIndex?: boolean;
+    /**
+     * Specifies if clicking the modal background should hide the dialog.
+     */
     dismissableMask?: boolean;
+    /**
+     * Inline style of the component.
+     */
     rtl?: boolean;
-    style?: any;
-    contentStyle?: any;
+    /**
+     * Inline style of the comopnent.
+     */
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Inline style of the content.
+     */
+    contentStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     */
     styleClass?: string;
+    /**
+     * Transition options of the animation.
+     */
     transitionOptions?: string;
+    /**
+     * Adds a close icon to the header to hide the dialog.
+     */
     closable?: boolean;
+    /**
+     * Whether to show the header or not.
+     */
     showHeader?: boolean;
+    /**
+     * Defines if background should be blocked when dialog is displayed.
+     */
     modal?: boolean;
+    /**
+     * Style class of the mask.
+     */
     maskStyleClass?: string;
+    /**
+     * Enables resizing of the content.
+     */
     resizable?: boolean;
+    /**
+     * Enables dragging to change the position using header.
+     */
     draggable?: boolean;
+    /**
+     * Keeps dialog in the viewport.
+     */
     keepInViewport?: boolean;
+    /**
+     * Minimum value for the left coordinate of dialog in dragging.
+     */
     minX?: number;
+    /**
+     * Minimum value for the top coordinate of dialog in dragging.
+     */
     minY?: number;
+    /**
+     * Whether the dialog can be displayed full screen.
+     */
     maximizable?: boolean;
+    /**
+     * Name of the maximize icon.
+     */
     maximizeIcon?: string;
+    /**
+     * Name of the minimize icon.
+     */
     minimizeIcon?: string;
+    /**
+     * Position of the dialog, options are "center", "top", "bottom", "left", "right", "top-left", "top-right", "bottom-left" or "bottom-right".
+     */
     position?: string;
 }

package/dynamicdialog/dynamicdialog-ref.d.ts

@@ -1,25 +1,95 @@
 import { Observable } from 'rxjs';
+/**
+ * Dynamic Dialog instance.
+ * @group Components
+ */
 export declare class DynamicDialogRef {
     constructor();
+    /**
+     * Closes dialog.
+     * @group Method
+     */
     close(result?: any): void;
+    /**
+     * Destroys the dialog instance.
+     * @group Method
+     */
     destroy(): void;
+    /**
+     * Callback to invoke on drag start.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Method
+     */
     dragStart(event: MouseEvent): void;
+    /**
+     * Callback to invoke on drag end.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Method
+     */
     dragEnd(event: MouseEvent): void;
+    /**
+     * Callback to invoke on resize start.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Method
+     */
     resizeInit(event: MouseEvent): void;
+    /**
+     * Callback to invoke on resize start.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Method
+     */
     resizeEnd(event: MouseEvent): void;
+    /**
+     * Callback to invoke on dialog is maximized.
+     * @param {*} value - Size value.
+     * @group Method
+     */
     maximize(value: any): void;
     private readonly _onClose;
+    /**
+     * Event triggered on dialog is closed.
+     * @group Events
+     */
     onClose: Observable<any>;
     private readonly _onDestroy;
+    /**
+     * Event triggered on dialog instance is destroyed.
+     * @group Events
+     */
     onDestroy: Observable<any>;
     private readonly _onDragStart;
+    /**
+     * Event triggered on drag start.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Events
+     */
     onDragStart: Observable<any>;
     private readonly _onDragEnd;
+    /**
+     * Event triggered on drag end.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Events
+     */
     onDragEnd: Observable<any>;
     private readonly _onResizeInit;
+    /**
+     * Event triggered on resize start.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Events
+     */
     onResizeInit: Observable<any>;
     private readonly _onResizeEnd;
+    /**
+     * Event triggered on resize end.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Events
+     */
     onResizeEnd: Observable<any>;
     private readonly _onMaximize;
+    /**
+     * Event triggered on resize end.
+     * @param {*} value - Size value.
+     * @group Events
+     */
     onMaximize: Observable<any>;
 }

package/dynamicdialog/dynamicdialog.d.ts

@@ -1,6 +1,7 @@
 import { AnimationEvent } from '@angular/animations';
 import { AfterViewInit, ChangeDetectorRef, ComponentFactoryResolver, ComponentRef, ElementRef, NgZone, OnDestroy, Renderer2, Type } from '@angular/core';
 import { PrimeNGConfig } from 'primeng/api';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import { DynamicDialogConfig } from './dynamicdialog-config';
 import { DynamicDialogRef } from './dynamicdialog-ref';
 import { DynamicDialogContent } from './dynamicdialogcontent';
@@ -23,30 +24,30 @@ export declare class DynamicDialogComponent implements AfterViewInit, OnDestroy
     primeNGConfig: PrimeNGConfig;
     private parentDialog;
     visible: boolean;
-    componentRef: ComponentRef<any>;
-    mask: HTMLDivElement;
-    resizing: boolean;
-    dragging: boolean;
-    maximized: boolean;
+    componentRef: Nullable<ComponentRef<any>>;
+    mask: Nullable<HTMLDivElement>;
+    resizing: boolean | undefined;
+    dragging: boolean | undefined;
+    maximized: boolean | undefined;
     _style: any;
     originalStyle: any;
-    lastPageX: number;
-    lastPageY: number;
-    insertionPoint: DynamicDialogContent;
-    maskViewChild: ElementRef;
-    contentViewChild: ElementRef;
-    headerViewChild: ElementRef;
-    childComponentType: Type<any>;
-    container: HTMLDivElement;
-    wrapper: HTMLElement;
-    documentKeydownListener: () => void | null;
-    documentEscapeListener: () => void | null;
-    maskClickListener: () => void | null;
+    lastPageX: number | undefined;
+    lastPageY: number | undefined;
+    insertionPoint: Nullable<DynamicDialogContent>;
+    maskViewChild: Nullable<ElementRef>;
+    contentViewChild: Nullable<ElementRef>;
+    headerViewChild: Nullable<ElementRef>;
+    childComponentType: Nullable<Type<any>>;
+    container: Nullable<HTMLDivElement>;
+    wrapper: Nullable<HTMLElement>;
+    documentKeydownListener: VoidListener;
+    documentEscapeListener: VoidListener;
+    maskClickListener: VoidListener;
     transformOptions: string;
-    documentResizeListener: () => void | null;
-    documentResizeEndListener: () => void | null;
-    documentDragListener: () => void | null;
-    documentDragEndListener: () => void | null;
+    documentResizeListener: VoidListener;
+    documentResizeEndListener: VoidListener;
+    documentDragListener: VoidListener;
+    documentDragEndListener: VoidListener;
     get minX(): number;
     get minY(): number;
     get keepInViewport(): boolean;

package/editor/editor.d.ts

@@ -1,31 +1,93 @@
 import { ElementRef, AfterViewInit, EventEmitter, QueryList, AfterContentInit, TemplateRef, AfterViewChecked } from '@angular/core';
+import { PrimeTemplate } from 'primeng/api';
 import { ControlValueAccessor } from '@angular/forms';
+import { EditorInitEvent, EditorTextChangeEvent, EditorSelectionChangeEvent } from './editor.interface';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
 export declare const EDITOR_VALUE_ACCESSOR: any;
+/**
+ * Editor groups a collection of contents in tabs.
+ * @group Components
+ */
 export declare class Editor implements AfterViewInit, AfterViewChecked, AfterContentInit, ControlValueAccessor {
     el: ElementRef;
-    onTextChange: EventEmitter<any>;
-    onSelectionChange: EventEmitter<any>;
+    /**
+     * Inline style of the container.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the container.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Placeholder text to show when editor is empty.
+     * @group Props
+     */
+    placeholder: string | undefined;
+    /**
+     * Whitelist of formats to display, see here for available options.
+     * @group Props
+     */
+    formats: string[] | undefined;
+    /**
+     * Modules configuration of Editor, see here for available options.
+     * @group Props
+     */
+    modules: object | undefined;
+    /**
+     * DOM Element or a CSS selector for a DOM Element, within which the editor’s p elements (i.e. tooltips, etc.) should be confined. Currently, it only considers left and right boundaries.
+     * @group Props
+     */
+    bounds: HTMLElement | string | undefined;
+    /**
+     * DOM Element or a CSS selector for a DOM Element, specifying which container has the scrollbars (i.e. overflow-y: auto), if is has been changed from the default ql-editor with custom CSS. Necessary to fix scroll jumping bugs when Quill is set to auto grow its height, and another ancestor container is responsible from the scrolling..
+     * @group Props
+     */
+    scrollingContainer: HTMLElement | string | undefined;
+    /**
+     * Shortcut for debug. Note debug is a static method and will affect other instances of Quill editors on the page. Only warning and error messages are enabled by default.
+     * @group Props
+     */
+    debug: string | undefined;
+    /**
+     * Whether to instantiate the editor to read-only mode.
+     * @group Props
+     */
+    get readonly(): boolean;
+    set readonly(val: boolean);
+    /**
+     * Callback to invoke when the quill modules are loaded.
+     * @param {EditorInitEvent} event - custom event.
+     * @group Emits
+     */
+    onInit: EventEmitter<EditorInitEvent>;
+    /**
+     * Callback to invoke when text of editor changes.
+     * @param {EditorTextChangeEvent} event - custom event.
+     * @group Emits
+     */
+    onTextChange: EventEmitter<EditorTextChangeEvent>;
+    /**
+     * Callback to invoke when selection of the text changes.
+     * @param {EditorSelectionChangeEvent} event - custom event.
+     * @group Emits
+     */
+    onSelectionChange: EventEmitter<EditorSelectionChangeEvent>;
+    templates: QueryList<PrimeTemplate>;
     toolbar: any;
-    style: any;
-    styleClass: string;
-    placeholder: string;
-    formats: string[];
-    modules: any;
-    bounds: any;
-    scrollingContainer: any;
-    debug: string;
-    onInit: EventEmitter<any>;
-    templates: QueryList<any>;
-    value: string;
+    value: Nullable<string>;
     delayedCommand: Function | null;
     _readonly: boolean;
     onModelChange: Function;
     onModelTouched: Function;
     quill: any;
-    headerTemplate: TemplateRef<any>;
+    headerTemplate: Nullable<TemplateRef<any>>;
     private get isAttachedQuillEditorToDOM();
     private quillElements;
     constructor(el: ElementRef);
@@ -36,12 +98,10 @@ export declare class Editor implements AfterViewInit, AfterViewChecked, AfterCon
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;
     getQuill(): any;
-    get readonly(): boolean;
-    set readonly(val: boolean);
     private initQuillEditor;
     private initQuillElements;
     static ɵfac: i0.ɵɵFactoryDeclaration<Editor, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<Editor, "p-editor", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "formats": { "alias": "formats"; "required": false; }; "modules": { "alias": "modules"; "required": false; }; "bounds": { "alias": "bounds"; "required": false; }; "scrollingContainer": { "alias": "scrollingContainer"; "required": false; }; "debug": { "alias": "debug"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "onTextChange": "onTextChange"; "onSelectionChange": "onSelectionChange"; "onInit": "onInit"; }, ["toolbar", "templates"], ["p-header"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Editor, "p-editor", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "formats": { "alias": "formats"; "required": false; }; "modules": { "alias": "modules"; "required": false; }; "bounds": { "alias": "bounds"; "required": false; }; "scrollingContainer": { "alias": "scrollingContainer"; "required": false; }; "debug": { "alias": "debug"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "onInit": "onInit"; "onTextChange": "onTextChange"; "onSelectionChange": "onSelectionChange"; }, ["toolbar", "templates"], ["p-header"], false, never>;
 }
 export declare class EditorModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<EditorModule, never>;

package/editor/editor.interface.d.ts

@@ -0,0 +1,64 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom text change event.
+ * @see {@link Editor.onTextChange}
+ * @group Events
+ */
+export interface EditorTextChangeEvent {
+    /**
+     * Current value as html.
+     */
+    htmlValue: string;
+    /**
+     * Current value as text.
+     */
+    textValue: string;
+    /**
+     * Representation of the change.
+     */
+    delta: string;
+    /**
+     * Source of change. Will be either 'user' or 'api'.
+     */
+    source: string;
+}
+/**
+ * Custom selection change event.
+ * @see {@link Editor.onSelectionChange}
+ * @group Events
+ */
+export interface EditorSelectionChangeEvent {
+    /**
+     * Representation of the selection boundaries.
+     */
+    range: string;
+    /**
+     * Representation of the previous selection boundaries.
+     */
+    oldRange: string;
+    /**
+     * Source of change. Will be either 'user' or 'api'.
+     */
+    source: string;
+}
+/**
+ * Custom load event.
+ * @see {@link Editor.onInit}
+ * @group Events
+ */
+export interface EditorInitEvent {
+    /**
+     * Text editor instance.
+     */
+    editor: any;
+}
+/**
+ * Defines valid templates in Editor.
+ * @group Templates
+ */
+export interface EditorTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+}

package/editor/public_api.d.ts

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

package/esm2022/accordion/accordion.interface.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWNjb3JkaW9uLmludGVyZmFjZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9hcHAvY29tcG9uZW50cy9hY2NvcmRpb24vYWNjb3JkaW9uLmludGVyZmFjZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgVGVtcGxhdGVSZWYgfSBmcm9tICdAYW5ndWxhci9jb3JlJztcblxuLyoqXG4gKiBDdXN0b20gdGFiIG9wZW4gZXZlbnQuXG4gKiBAc2VlIHtAbGluayBBY2NvcmRpb24ub25PcGVufVxuICogQGdyb3VwIEV2ZW50c1xuICovXG5leHBvcnQgaW50ZXJmYWNlIEFjY29yZGlvblRhYk9wZW5FdmVudCB7XG4gICAgLyoqXG4gICAgICogQnJvd3NlciBldmVudC5cbiAgICAgKi9cbiAgICBvcmlnaW5hbEV2ZW50OiBFdmVudDtcbiAgICAvKipcbiAgICAgKiBPcGVuZWQgdGFiIGluZGV4LlxuICAgICAqL1xuICAgIGluZGV4OiBudW1iZXI7XG59XG5cbi8qKlxuICogQ3VzdG9tIHRhYiBjbG9zZSBldmVudC5cbiAqIEBzZWUge0BsaW5rIEFjY29yZGlvbi5vbkNsb3NlfVxuICogQGV4dGVuZHMge0FjY29yZGlvblRhYk9wZW5FdmVudH1cbiAqIEBncm91cCBFdmVudHNcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBBY2NvcmRpb25UYWJDbG9zZUV2ZW50IGV4dGVuZHMgQWNjb3JkaW9uVGFiT3BlbkV2ZW50IHt9XG5cbi8qKlxuICogRGVmaW5lcyB2YWxpZCB0ZW1wbGF0ZXMgaW4gQWNjb3JkaW9uLlxuICogQGdyb3VwIFRlbXBsYXRlc1xuICovXG5leHBvcnQgaW50ZXJmYWNlIEFjY29yZGlvblRlbXBsYXRlcyB7XG4gICAgLyoqXG4gICAgICogQ3VzdG9tIHRlbXBsYXRlIG9mIGNvbnRlbnQuXG4gICAgICovXG4gICAgY29udGVudCgpOiBUZW1wbGF0ZVJlZjxhbnk+O1xuICAgIC8qKlxuICAgICAqIEN1c3RvbSB0ZW1wbGF0ZSBvZiBoZWFkZXIuXG4gICAgICovXG4gICAgaGVhZGVyKCk6IFRlbXBsYXRlUmVmPGFueT47XG4gICAgLyoqXG4gICAgICogQ3VzdG9tIHRlbXBsYXRlIG9mIGljb24uXG4gICAgICovXG4gICAgaWNvbihjb250ZXh0OiB7XG4gICAgICAgIC8qKlxuICAgICAgICAgKiBEYXRhIG9mIHRoZSBzZWxlY3RlZC5cbiAgICAgICAgICovXG4gICAgICAgICRpbXBsaWNpdDogYW55O1xuICAgIH0pOiBUZW1wbGF0ZVJlZjx7ICRpbXBsaWNpdDogYW55IH0+O1xufVxuIl19