primeng 16.0.0-rc.2 → 16.0.0

package/carousel/carousel.d.ts

@@ -1,6 +1,6 @@
 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 { CarouselPageEvent, CarouselResponsiveOptions } from './carousel.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
@@ -9,6 +9,10 @@ import * as i4 from "primeng/icons/chevronright";
 import * as i5 from "primeng/icons/chevronleft";
 import * as i6 from "primeng/icons/chevrondown";
 import * as i7 from "primeng/icons/chevronup";
+/**
+ * Carousel is a content slider featuring various customization options.
+ * @group Components
+ */
 export declare class Carousel implements AfterContentInit {
     el: ElementRef;
     zone: NgZone;
@@ -18,33 +22,36 @@ export declare class Carousel implements AfterContentInit {
     private platformId;
     /**
      * Index of the first item.
+     * @defaultValue 0
      * @group Props
      */
     get page(): number;
     set page(val: number);
     /**
      * Number of items per page.
+     * @defaultValue 1
      * @group Props
      */
     get numVisible(): number;
     set numVisible(val: number);
     /**
      * Number of items to scroll.
+     * @defaultValue 1
      * @group Props
      */
     get numScroll(): number;
     set numScroll(val: number);
     /**
      * An array of options for responsive design.
-     * @see CarouselResponsiveOptions
+     * @see {CarouselResponsiveOptions}
      * @group Props
      */
     responsiveOptions: CarouselResponsiveOptions[] | undefined;
     /**
-     * Specifies the layout of the component, valid values are 'horizontal' and 'vertical'.
+     * Specifies the layout of the component.
      * @group Props
      */
-    orientation: string;
+    orientation: 'horizontal' | 'vertical';
     /**
      * Height of the viewport in vertical layout.
      * @group Props
@@ -81,6 +88,7 @@ export declare class Carousel implements AfterContentInit {
     } | null | undefined;
     /**
      * An array of objects to display.
+     * @defaultValue null
      * @group Props
      */
     get value(): any[];
@@ -119,12 +127,10 @@ export declare class Carousel implements AfterContentInit {
     styleClass: string | undefined;
     /**
      * Callback to invoke after scroll.
-     * @param {Object} event - custom page event.
+     * @param {CarouselPageEvent} event - Custom page event.
      * @group Emits
      */
-    onPage: EventEmitter<{
-        page: number;
-    }>;
+    onPage: EventEmitter<CarouselPageEvent>;
     itemsContainer: ElementRef | undefined;
     headerFacet: QueryList<Header> | undefined;
     footerFacet: QueryList<Footer> | undefined;

package/carousel/carousel.interface.d.ts

@@ -1,6 +1,7 @@
 import { TemplateRef } from '@angular/core';
 /**
  * Responsive options of the component.
+ * @group Interface
  */
 export interface CarouselResponsiveOptions {
     /**
@@ -16,6 +17,16 @@ export interface CarouselResponsiveOptions {
      */
     numScroll: number;
 }
+/**
+ * Custom page event.
+ * @group Events
+ */
+export interface CarouselPageEvent {
+    /**
+     * Current page.
+     */
+    page?: number;
+}
 /**
  * Defines valid templates in Carousel.
  * @group Templates
@@ -24,7 +35,7 @@ export interface CarouselTemplates {
     /**
      * Custom template of header.
      */
-    header: TemplateRef<any> | null;
+    header(): TemplateRef<any>;
     /**
      * Custom template of item.
      * @param {Object} context - item data.
@@ -40,13 +51,13 @@ export interface CarouselTemplates {
     /**
      * Custom template of previousicon.
      */
-    previousicon: TemplateRef<any> | null;
+    previousicon(): TemplateRef<any>;
     /**
      * Custom template of nexticon.
      */
-    nexticon: TemplateRef<any> | null;
+    nexticon(): TemplateRef<any>;
     /**
      * Custom template of footer.
      */
-    footer: TemplateRef<any> | null;
+    footer(): TemplateRef<any>;
 }

package/cascadeselect/cascadeselect.d.ts

@@ -55,6 +55,10 @@ export declare class CascadeSelectSub implements OnInit {
     static ɵfac: i0.ɵɵFactoryDeclaration<CascadeSelectSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CascadeSelectSub, "p-cascadeSelectSub", never, { "selectionPath": { "alias": "selectionPath"; "required": false; }; "options": { "alias": "options"; "required": false; }; "optionGroupChildren": { "alias": "optionGroupChildren"; "required": false; }; "optionTemplate": { "alias": "optionTemplate"; "required": false; }; "groupIconTemplate": { "alias": "groupIconTemplate"; "required": false; }; "level": { "alias": "level"; "required": false; }; "optionLabel": { "alias": "optionLabel"; "required": false; }; "optionValue": { "alias": "optionValue"; "required": false; }; "optionGroupLabel": { "alias": "optionGroupLabel"; "required": false; }; "dirty": { "alias": "dirty"; "required": false; }; "root": { "alias": "root"; "required": false; }; "parentActive": { "alias": "parentActive"; "required": false; }; }, { "onSelect": "onSelect"; "onGroupSelect": "onGroupSelect"; }, never, never, false, never>;
 }
+/**
+ * CascadeSelect is a form component to select a value from a nested structure of options.
+ * @group Components
+ */
 export declare class CascadeSelect implements OnInit, AfterContentInit {
     private el;
     private cd;
@@ -96,7 +100,7 @@ export declare class CascadeSelect implements OnInit, AfterContentInit {
      * Property name or getter function to retrieve the items of a group.
      * @group Props
      */
-    optionGroupChildren: string | undefined;
+    optionGroupChildren: string | string[] | undefined;
     /**
      * Default text to display when no option is selected.
      * @group Props
@@ -185,16 +189,16 @@ export declare class CascadeSelect implements OnInit, AfterContentInit {
      * @param {Event} event - Browser event.
      * @group Emits
      */
-    onGroupChange: EventEmitter<any>;
+    onGroupChange: EventEmitter<Event>;
     /**
      * Callback to invoke when the overlay is shown.
-     * @param {CascadeSelectShowEvent } - custom event.
+     * @param {CascadeSelectShowEvent} event - Custom overlay show event.
      * @group Emits
      */
     onShow: EventEmitter<CascadeSelectShowEvent>;
     /**
      * Callback to invoke when the overlay is hidden.
-     * @param {CascadeSelectHideEvent} - custom event.
+     * @param {CascadeSelectHideEvent} event - Custom overlay hide event.
      * @group Emits
      */
     onHide: EventEmitter<CascadeSelectHideEvent>;
@@ -205,26 +209,27 @@ export declare class CascadeSelect implements OnInit, AfterContentInit {
     onClear: EventEmitter<any>;
     /**
      * Callback to invoke before overlay is shown.
-     * @param {CascadeSelectBeforeShowEvent} - custom event.
+     * @param {CascadeSelectBeforeShowEvent} event - Custom overlay show event.
      * @group Emits
      */
     onBeforeShow: EventEmitter<CascadeSelectBeforeShowEvent>;
     /**
      * Callback to invoke before overlay is hidden.
+     * @param {CascadeSelectBeforeHideEvent} event - Custom overlay hide event.
      * @group Emits
      */
     onBeforeHide: EventEmitter<CascadeSelectBeforeHideEvent>;
     /**
-     * @deprecated deprecated since v14.2.0, use overlayOptions property instead.
      * Transition options of the show animation.
      * @group Props
+     * @deprecated deprecated since v14.2.0, use overlayOptions property instead.
      */
     get showTransitionOptions(): string;
     set showTransitionOptions(val: string);
     /**
-     * @deprecated deprecated since v14.2.0, use overlayOptions property instead.
      * Transition options of the hide animation.
      * @group Props
+     * @deprecated deprecated since v14.2.0, use overlayOptions property instead.
      */
     get hideTransitionOptions(): string;
     set hideTransitionOptions(val: string);

package/cascadeselect/cascadeselect.interface.d.ts

@@ -3,6 +3,7 @@ import { Overlay } from 'primeng/overlay';
 /**
  * Custom panel show event.
  * @see {@link CascadeSelect.onShow}
+ * @group Events
  */
 export interface CascadeSelectShowEvent {
     /**
@@ -22,6 +23,7 @@ export interface CascadeSelectShowEvent {
  * Custom panel hide event.
  * @see {@link CascadeSelect.onHide}
  * @extends {CascadeSelectShowEvent}
+ * @group Events
  */
 export interface CascadeSelectHideEvent extends CascadeSelectShowEvent {
 }
@@ -29,6 +31,7 @@ export interface CascadeSelectHideEvent extends CascadeSelectShowEvent {
  * Custom panel show event emits right before the panel is shown.
  * @see {@link CascadeSelect.onBeforeShow}
  * @extends {CascadeSelectShowEvent}
+ * @group Events
  */
 export interface CascadeSelectBeforeShowEvent extends CascadeSelectShowEvent {
 }
@@ -36,6 +39,7 @@ export interface CascadeSelectBeforeShowEvent extends CascadeSelectShowEvent {
  * Custom panel hide event emits right before the panel is hidden.
  * @see {@link CascadeSelect.onBeforeHide}
  * @extends {CascadeSelectShowEvent}
+ * @group Events
  */
 export interface CascadeSelectBeforeHideEvent extends CascadeSelectShowEvent {
 }
@@ -76,13 +80,13 @@ export interface CascadeSelectTemplates {
     /**
      * Custom dropdown trigger icon template.
      */
-    triggericon: TemplateRef<any>;
+    triggericon(): TemplateRef<any>;
     /**
      * Custom clear icon template.
      */
-    clearicon: TemplateRef<any>;
+    clearicon(): TemplateRef<any>;
     /**
      * Custom option group icon template.
      */
-    optiongroupicon: TemplateRef<any>;
+    optiongroupicon(): TemplateRef<any>;
 }

package/chart/chart.d.ts

@@ -1,6 +1,10 @@
 import { ElementRef, AfterViewInit, OnDestroy, EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Chart groups a collection of contents in tabs.
+ * @group Components
+ */
 export declare class UIChart implements AfterViewInit, OnDestroy {
     private platformId;
     el: ElementRef;
@@ -47,13 +51,13 @@ export declare class UIChart implements AfterViewInit, OnDestroy {
      */
     onDataSelect: EventEmitter<any>;
     isBrowser: boolean;
-    initialized: boolean;
+    initialized: boolean | undefined;
     _data: any;
     _options: any;
     chart: any;
     constructor(platformId: any, el: ElementRef);
     ngAfterViewInit(): void;
-    onCanvasClick(event: any): void;
+    onCanvasClick(event: Event): void;
     initChart(): void;
     getCanvas(): any;
     getBase64Image(): any;

package/checkbox/checkbox.d.ts

@@ -8,6 +8,10 @@ import * as i1 from "@angular/common";
 import * as i2 from "primeng/icons/check";
 import * as i3 from "primeng/api";
 export declare const CHECKBOX_VALUE_ACCESSOR: any;
+/**
+ * Checkbox is an extension to standard checkbox element with theming.
+ * @group Components
+ */
 export declare class Checkbox implements ControlValueAccessor {
     cd: ChangeDetectorRef;
     /**
@@ -104,7 +108,7 @@ export declare class Checkbox implements ControlValueAccessor {
     falseValue: any;
     /**
      * Callback to invoke on value change.
-     * @param {CheckboxChangeEvent} event - Browser event.
+     * @param {CheckboxChangeEvent} event - Custom value change event.
      * @group Emits
      */
     onChange: EventEmitter<CheckboxChangeEvent>;

package/checkbox/checkbox.interface.d.ts

@@ -2,6 +2,7 @@ import { TemplateRef } from '@angular/core';
 /**
  * Custom change event.
  * @see {@link Checkbox.onChange}
+ * @group Events
  */
 export interface CheckboxChangeEvent {
     /**
@@ -21,5 +22,5 @@ export interface CheckboxTemplates {
     /**
      * Custom checkbox icon template
      */
-    icon: TemplateRef<any>;
+    icon(): TemplateRef<any>;
 }

package/chip/chip.d.ts

@@ -4,6 +4,10 @@ import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/icons/timescircle";
 import * as i3 from "primeng/api";
+/**
+ * Chip represents people using icons, labels and images.
+ * @group Components
+ */
 export declare class Chip implements AfterContentInit {
     /**
      * Defines the text to display.

package/chip/chip.interface.d.ts

@@ -7,9 +7,9 @@ export interface ChipTemplates {
     /**
      * Custom template of content.
      */
-    content: TemplateRef<any> | null;
+    content(): TemplateRef<any>;
     /**
      * Custom template of remove icon.
      */
-    removeicon: TemplateRef<any> | null;
+    removeicon(): TemplateRef<any>;
 }

package/chips/chips.d.ts

@@ -9,6 +9,10 @@ import * as i3 from "primeng/api";
 import * as i4 from "primeng/icons/timescircle";
 import * as i5 from "primeng/icons/times";
 export declare const CHIPS_VALUE_ACCESSOR: any;
+/**
+ * Chips groups a collection of contents in tabs.
+ * @group Components
+ */
 export declare class Chips implements AfterContentInit, ControlValueAccessor {
     private document;
     el: ElementRef;
@@ -69,12 +73,14 @@ export declare class Chips implements AfterContentInit, ControlValueAccessor {
      * Inline style of the input field.
      * @group Props
      */
-    inputStyle: any;
+    inputStyle: {
+        [klass: string]: any;
+    } | null | undefined;
     /**
      * Style class of the input field.
      * @group Props
      */
-    inputStyleClass: any;
+    inputStyleClass: string | undefined;
     /**
      * Whether to add an item on tab key press.
      * @group Props
@@ -97,31 +103,31 @@ export declare class Chips implements AfterContentInit, ControlValueAccessor {
     showClear: boolean;
     /**
      * Callback to invoke on chip add.
-     * @param {ChipsAddEvent} event - Custom event.
+     * @param {ChipsAddEvent} event - Custom chip add event.
      * @group Emits
      */
     onAdd: EventEmitter<ChipsAddEvent>;
     /**
      * Callback to invoke on chip remove.
-     * @param {ChipsRemoveEvent} event - Custom event.
+     * @param {ChipsRemoveEvent} event - Custom chip remove event.
      * @group Emits
      */
     onRemove: EventEmitter<ChipsRemoveEvent>;
     /**
      * Callback to invoke on focus of input field.
-     * @param {Event} event - Focus event
+     * @param {Event} event - Browser event.
      * @group Emits
      */
     onFocus: EventEmitter<Event>;
     /**
      * Callback to invoke on blur of input field.
-     * @param {Event} event - Blur event
+     * @param {Event} event - Browser event.
      * @group Emits
      */
     onBlur: EventEmitter<Event>;
     /**
      * Callback to invoke on chip clicked.
-     * @param {ChipsClickEvent} event - Custom event
+     * @param {ChipsClickEvent} event - Custom chip click event.
      * @group Emits
      */
     onChipClick: EventEmitter<ChipsClickEvent>;

package/chips/chips.interface.d.ts

@@ -2,6 +2,7 @@ import { TemplateRef } from '@angular/core';
 /**
  * Custom add event.
  * @see {@link Chips.onAdd}
+ * @group Events
  */
 export interface ChipsAddEvent {
     /**
@@ -17,6 +18,7 @@ export interface ChipsAddEvent {
  * Custom remove event.
  * @see {@link Chips.onRemove}
  * @extends {ChipsAddEvent}
+ * @group Events
  */
 export interface ChipsRemoveEvent extends ChipsAddEvent {
 }
@@ -24,6 +26,7 @@ export interface ChipsRemoveEvent extends ChipsAddEvent {
  * Custom click event.
  * @see {@link Chips.onChipClick}
  * @extends {ChipsAddEvent}
+ * @group Events
  */
 export interface ChipsClickEvent extends ChipsAddEvent {
 }
@@ -43,13 +46,13 @@ export interface ChipsTemplates {
         $implicit: any;
     }): TemplateRef<{
         $implicit: any;
-    }> | null;
+    }>;
     /**
      * Custom remove icon template.
      */
-    removetokenicon: TemplateRef<any> | null;
+    removetokenicon(): TemplateRef<any>;
     /**
      * Custom clear icon template.
      */
-    clearicon: TemplateRef<any> | null;
+    clearicon(): TemplateRef<any>;
 }

package/colorpicker/colorpicker.d.ts

@@ -8,6 +8,10 @@ import { ColorPickerChangeEvent } from './colorpicker.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare const COLORPICKER_VALUE_ACCESSOR: any;
+/**
+ * ColorPicker groups a collection of contents in tabs.
+ * @group Components
+ */
 export declare class ColorPicker implements ControlValueAccessor, OnDestroy {
     private document;
     private platformId;
@@ -34,7 +38,7 @@ export declare class ColorPicker implements ControlValueAccessor, OnDestroy {
      */
     inline: boolean | undefined;
     /**
-     * Format to use in value binding, supported formats are "hex", "rgb" and "hsb".
+     * Format to use in value binding.
      * @group Props
      */
     format: 'hex' | 'rgb' | 'hsb';
@@ -80,7 +84,7 @@ export declare class ColorPicker implements ControlValueAccessor, OnDestroy {
     hideTransitionOptions: string;
     /**
      * Callback to invoke on value change.
-     * @param {ColorPickerChangeEvent} event - Custom event.
+     * @param {ColorPickerChangeEvent} event - Custom value change event.
      * @group Emits
      */
     onChange: EventEmitter<ColorPickerChangeEvent>;

package/colorpicker/colorpicker.interface.d.ts

@@ -1,6 +1,7 @@
 /**
  * Custom change event.
  * @see {@link ColorPicker.onChange}
+ * @group Events
  */
 export interface ColorPickerChangeEvent {
     /**

package/confirmdialog/confirmdialog.d.ts

@@ -1,8 +1,8 @@
 import { AnimationEvent } from '@angular/animations';
 import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, QueryList, Renderer2, TemplateRef } from '@angular/core';
 import { ConfirmEventType, Confirmation, ConfirmationService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
-import { Subscription } from 'rxjs';
 import { Nullable } from 'primeng/ts-helpers';
+import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/button";
@@ -10,6 +10,10 @@ import * as i3 from "primeng/ripple";
 import * as i4 from "primeng/icons/times";
 import * as i5 from "primeng/icons/check";
 import * as i6 from "primeng/api";
+/**
+ * ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API.
+ * @group Components
+ */
 export declare class ConfirmDialog implements AfterContentInit, OnInit, OnDestroy {
     el: ElementRef;
     renderer: Renderer2;
@@ -156,7 +160,7 @@ export declare class ConfirmDialog implements AfterContentInit, OnInit, OnDestro
      */
     focusTrap: boolean;
     /**
-     * Element to receive the focus when the dialog gets visible, valid values are "accept", "reject", "close" and "none".
+     * Element to receive the focus when the dialog gets visible.
      * @group Props
      */
     defaultFocus: 'accept' | 'reject' | 'close';
@@ -179,7 +183,7 @@ export declare class ConfirmDialog implements AfterContentInit, OnInit, OnDestro
     set position(value: string);
     /**
      * Callback to invoke when dialog is hidden.
-     * @param {ConfirmEventType} enum - confirm event type.
+     * @param {ConfirmEventType} enum - Custom confirm event.
      * @group Emits
      */
     onHide: EventEmitter<ConfirmEventType>;

package/confirmdialog/confirmdialog.interface.d.ts

@@ -7,17 +7,17 @@ export interface ConfirmDialogTemplates {
     /**
      * Custom template of header.
      */
-    header: TemplateRef<any> | null;
+    header(): TemplateRef<any>;
     /**
      * Custom template of footer.
      */
-    footer: TemplateRef<any> | null;
+    footer(): TemplateRef<any>;
     /**
      * Custom template of rejecticon.
      */
-    rejecticon: TemplateRef<any> | null;
+    rejecticon(): TemplateRef<any>;
     /**
      * Custom template of accepticon.
      */
-    accepticon: TemplateRef<any> | null;
+    accepticon(): TemplateRef<any>;
 }

package/confirmpopup/confirmpopup.d.ts

@@ -2,12 +2,16 @@ import { AnimationEvent } from '@angular/animations';
 import { AfterContentInit, ChangeDetectorRef, ElementRef, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
 import { Confirmation, ConfirmationService, OverlayService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { ConnectedOverlayScrollHandler } from 'primeng/dom';
-import { Subscription } from 'rxjs';
 import { Nullable, VoidListener } from 'primeng/ts-helpers';
+import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/button";
 import * as i3 from "primeng/api";
+/**
+ * ConfirmPopup displays a confirmation overlay displayed relatively to its target.
+ * @group Components
+ */
 export declare class ConfirmPopup implements AfterContentInit, OnDestroy {
     el: ElementRef;
     private confirmationService;

package/confirmpopup/confirmpopup.interface.d.ts

@@ -7,9 +7,9 @@ export interface ConfirmPopupTemplates {
     /**
      * Custom template of rejecticon.
      */
-    rejecticon: TemplateRef<any> | null;
+    rejecticon(): TemplateRef<any>;
     /**
      * Custom template of accepticon.
      */
-    accepticon: TemplateRef<any> | null;
+    accepticon(): TemplateRef<any>;
 }

package/contextmenu/contextmenu.d.ts

@@ -1,7 +1,7 @@
 import { AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
 import { ContextMenuService, MenuItem, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
-import { Subject, Subscription } from 'rxjs';
 import { Nullable, VoidListener } from 'primeng/ts-helpers';
+import { Subject, Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
@@ -31,6 +31,10 @@ export declare class ContextMenuSub {
     static ɵfac: i0.ɵɵFactoryDeclaration<ContextMenuSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ContextMenuSub, "p-contextMenuSub", never, { "item": { "alias": "item"; "required": false; }; "root": { "alias": "root"; "required": false; }; "parentItemKey": { "alias": "parentItemKey"; "required": false; }; }, { "leafClick": "leafClick"; }, never, never, false, never>;
 }
+/**
+ * ContextMenu displays an overlay menu on right click of its target. Note that components like Table has special integration with ContextMenu.
+ * @group Components
+ */
 export declare class ContextMenu implements AfterViewInit, OnDestroy {
     private document;
     el: ElementRef;

package/dataview/dataview.d.ts

@@ -11,6 +11,10 @@ import * as i3 from "primeng/paginator";
 import * as i4 from "primeng/icons/spinner";
 import * as i5 from "primeng/icons/bars";
 import * as i6 from "primeng/icons/thlarge";
+/**
+ * DataView displays data in grid or list layout with pagination and sorting features.
+ * @group Components
+ */
 export declare class DataView implements OnInit, AfterContentInit, OnDestroy, BlockableUI, OnChanges {
     el: ElementRef;
     cd: ChangeDetectorRef;
@@ -158,28 +162,33 @@ export declare class DataView implements OnInit, AfterContentInit, OnDestroy, Bl
      * @group Props
      */
     value: any[] | undefined;
+    /**
+     * Defines the layout mode.
+     * @group Props
+     */
     get layout(): 'list' | 'grid';
     set layout(layout: 'list' | 'grid');
     /**
      * Callback to invoke when paging, sorting or filtering happens in lazy mode.
-     * @param {DataViewLazyLoadEvent} event - custom lazy load event.
+     * @param {DataViewLazyLoadEvent} event - Custom lazy load event.
      * @group Emits
      */
     onLazyLoad: EventEmitter<DataViewLazyLoadEvent>;
     /**
      * Callback to invoke when pagination occurs.
-     * @param {DataViewPageEvent} event - custom page event.
+     * @param {DataViewPageEvent} event - Custom page event.
      * @group Emits
      */
     onPage: EventEmitter<DataViewPageEvent>;
     /**
      * Callback to invoke when sorting occurs.
+     * @param {DataViewSortEvent} event - Custom sort event.
      * @group Emits
      */
     onSort: EventEmitter<DataViewSortEvent>;
     /**
      * Callback to invoke when changing layout.
-     * @param {DataViewLayoutChangeEvent} event - custom layout change event.
+     * @param {DataViewLayoutChangeEvent} event - Custom layout change event.
      * @group Emits
      */
     onChangeLayout: EventEmitter<DataViewLayoutChangeEvent>;