primeng 20.2.0 → 20.3.0-rc.1

package/types/confirmdialog/index.d.ts

@@ -0,0 +1,121 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { DialogPassThrough } from 'primeng/types/dialog';
+import { ButtonPassThrough } from 'primeng/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ConfirmDialog.pt}
+ * @group Interface
+ */
+interface ConfirmDialogPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     * @see {@link DialogPassThrough}
+     */
+    root?: DialogPassThrough;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the resize handle's DOM element.
+     */
+    resizeHandle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the title's DOM element.
+     */
+    title?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the header actions' DOM element.
+     */
+    headerActions?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the close Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcCloseButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the accept Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAcceptButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the reject Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcRejectButton?: ButtonPassThrough;
+}
+/**
+ * Defines valid pass-through options in ConfirmDialog.
+ * @see {@link ConfirmDialogPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ConfirmDialogPassThrough<I = unknown> = PassThrough<I, ConfirmDialogPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ConfirmDialog.
+ * @group Templates
+ */
+interface ConfirmDialogTemplates {
+    /**
+     * Custom template of header.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom template of footer.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom template of message.
+     */
+    message(context: {
+        $implicit?: any;
+    }): TemplateRef<any>;
+    /**
+     * Custom template of icon.
+     */
+    icon(): TemplateRef<any>;
+    /**
+     * Custom template of rejecticon.
+     */
+    rejecticon(): TemplateRef<any>;
+    /**
+     * Custom template of accepticon.
+     */
+    accepticon(): TemplateRef<any>;
+    /**
+     * Headless template.
+     */
+    headless(context: {
+        $implicit?: any;
+    }): TemplateRef<any>;
+}
+
+export type { ConfirmDialogPassThrough, ConfirmDialogPassThroughOptions, ConfirmDialogTemplates };

package/types/confirmpopup/index.d.ts

@@ -0,0 +1,82 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+import { TemplateRef } from '@angular/core';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ConfirmPopup.pt}
+ * @group Interface
+ */
+interface ConfirmPopupPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the reject Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcRejectButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the accept Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAcceptButton?: ButtonPassThrough;
+}
+/**
+ * Defines valid pass-through options in ConfirmPopup.
+ * @see {@link ConfirmPopupPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ConfirmPopupPassThrough<I = unknown> = PassThrough<I, ConfirmPopupPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ConfirmPopup.
+ * @group Templates
+ */
+interface ConfirmPopupTemplates {
+    /**
+     * Custom content template.
+     */
+    content(context: {
+        $implicit?: any;
+    }): TemplateRef<any>;
+    /**
+     * Custom template of rejecticon.
+     */
+    rejecticon(): TemplateRef<any>;
+    /**
+     * Custom template of accepticon.
+     */
+    accepticon(): TemplateRef<any>;
+    /**
+     * Headless template.
+     */
+    headless(context: {
+        $implicit?: any;
+    }): TemplateRef<any>;
+}
+
+export type { ConfirmPopupPassThrough, ConfirmPopupPassThroughOptions, ConfirmPopupTemplates };

package/types/contextmenu/index.d.ts

@@ -0,0 +1,89 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ContextMenu.pt}
+ * @group Interface
+ */
+interface ContextMenuPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root list's DOM element.
+     */
+    rootList?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the submenu's DOM element.
+     */
+    submenu?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the item content's DOM element.
+     */
+    itemContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the item link's DOM element.
+     */
+    itemLink?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the item icon's DOM element.
+     */
+    itemIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the item label's DOM element.
+     */
+    itemLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the submenu icon's DOM element.
+     */
+    submenuIcon?: PassThroughOption<SVGElement, I>;
+}
+/**
+ * Defines valid pass-through options in ContextMenu.
+ * @see {@link ContextMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ContextMenuPassThrough<I = unknown> = PassThrough<I, ContextMenuPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ContextMenu.
+ * @group Templates
+ */
+interface ContextMenuTemplates {
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: MenuItem;
+    }): TemplateRef<{
+        $implicit: MenuItem;
+    }>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(context: {
+        /**
+         * Style class of the submenu icon.
+         */
+        class: string;
+    }): TemplateRef<{
+        class: string;
+    }>;
+}
+
+export type { ContextMenuPassThrough, ContextMenuPassThroughOptions, ContextMenuTemplates };

package/types/dataview/index.d.ts

@@ -0,0 +1,234 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { TemplateRef } from '@angular/core';
+import { PaginatorPassThrough } from 'primeng/types/paginator';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link DataView.pt}
+ * @group Interface
+ */
+interface DataViewPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading container's DOM element.
+     */
+    loading?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading overlay's DOM element.
+     */
+    loadingOverlay?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content container's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Paginator component.
+     */
+    pcPaginator?: PaginatorPassThrough;
+}
+/**
+ * Defines valid pass-through options in DataView.
+ * @see {@link DataViewPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type DataViewPassThrough<I = unknown> = PassThrough<I, DataViewPassThroughOptions<I>>;
+/**
+ * State of the paginator.
+ * @group Interface
+ */
+interface DataViewPaginatorState {
+    /**
+     * Current page.
+     */
+    page?: number;
+    /**
+     * First item in the current page.
+     */
+    first?: number;
+    /**
+     * Row count.
+     */
+    rows?: number;
+    /**
+     * Page count.
+     */
+    pageCount?: number;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link DataView.onLazyLoad}
+ * @group Events
+ */
+interface DataViewLazyLoadEvent {
+    /**
+     * Index of the first element.
+     */
+    first: number;
+    /**
+     * Row count.
+     */
+    rows: number;
+    /**
+     * Property name of data to use in sorting by default.
+     */
+    sortField: string;
+    /**
+     * Order to sort the data by default.
+     */
+    sortOrder: number;
+}
+/**
+ * Custom page event.
+ * @see {@link DataView.onPage}
+ * @group Events
+ */
+interface DataViewPageEvent {
+    /**
+     * Index of the first element.
+     */
+    first: number;
+    /**
+     * Row count.
+     */
+    rows: number;
+}
+/**
+ * Custom sort event.
+ * @see {@link DataView.onSort}
+ * @group Events
+ */
+interface DataViewSortEvent {
+    /**
+     * Sort field.
+     */
+    sortField: string;
+    /**
+     * Sort order.
+     */
+    sortOrder: number;
+}
+/**
+ * Custom layout change.
+ * @see {@link DataView.onChangeLayout}
+ * @group Events
+ */
+interface DataViewLayoutChangeEvent {
+    /**
+     * Layout of the component.
+     */
+    layout: 'list' | 'grid';
+}
+/**
+ * Defines valid templates in DataView.
+ * @group Templates
+ */
+interface DataViewTemplates {
+    /**
+     * Custom list template.
+     * @param {Object} context - data of the DataView.
+     */
+    list(context: {
+        /**
+         * Rows data.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom grid template.
+     * @param {Object} context - data of the DataView.
+     */
+    grid(context: {
+        /**
+         * Rows data.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom paginator left template.
+     * @param {Object} context - paginator state.
+     */
+    paginatorleft(context: {
+        /**
+         * State of the paginator.
+         */
+        $implicit: DataViewPaginatorState;
+    }): TemplateRef<DataViewPaginatorState>;
+    /**
+     * Custom paginator right template.
+     * @param {Object} context - paginator state.
+     */
+    paginatorright(context: {
+        /**
+         * State of the paginator.
+         */
+        $implicit: DataViewPaginatorState;
+    }): TemplateRef<DataViewPaginatorState>;
+    /**
+     * Custom paginator dropdown template.
+     * @param {Object} context - dropdown item.
+     */
+    paginatordropdownitem(context: {
+        /**
+         * Dropdown item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom empty message template.
+     */
+    emptymessage(): TemplateRef<any>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom loading icon template.
+     */
+    loadingicon(): TemplateRef<any>;
+    /**
+     * Custom list icon template.
+     */
+    listicon(): TemplateRef<any>;
+    /**
+     * Custom grid icon template.
+     */
+    gridicon(): TemplateRef<any>;
+}
+
+export type { DataViewLayoutChangeEvent, DataViewLazyLoadEvent, DataViewPageEvent, DataViewPaginatorState, DataViewPassThrough, DataViewPassThroughOptions, DataViewSortEvent, DataViewTemplates };