primeng 20.2.0 → 20.3.0-rc.1

package/types/overlaybadge/index.d.ts

@@ -0,0 +1,34 @@
+import { BadgePassThrough } from 'primeng/types/badge';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link OverlayBadgeProps.pt}
+ * @group Interface
+ */
+interface OverlayBadgePassThroughOptions<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 Badge component.
+     * @see {@link BadgePassThrough}
+     */
+    pcBadge?: BadgePassThrough;
+}
+/**
+ * Defines valid pass-through options in OverlayBadge.
+ * @see {@link OverlayBadgePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type OverlayBadgePassThrough<I = unknown> = PassThrough<I, OverlayBadgePassThroughOptions<I>>;
+
+export type { OverlayBadgePassThrough, OverlayBadgePassThroughOptions };

package/types/paginator/index.d.ts

@@ -0,0 +1,131 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { InputNumberPassThrough } from 'primeng/types/inputnumber';
+import { SelectPassThrough } from 'primeng/types/select';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Paginator.pt}
+ * @group Interface
+ */
+interface PaginatorPassThroughOptions<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 start's DOM element.
+     */
+    contentStart?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the current page report's DOM element.
+     */
+    current?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the first page button's DOM element.
+     */
+    first?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the first page button icon's DOM element.
+     */
+    firstIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the previous page button's DOM element.
+     */
+    prev?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the previous page button icon's DOM element.
+     */
+    prevIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the pages container's DOM element.
+     */
+    pages?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the page button's DOM element.
+     */
+    page?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the next page button's DOM element.
+     */
+    next?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the next page button icon's DOM element.
+     */
+    nextIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the last page button's DOM element.
+     */
+    last?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the last page button icon's DOM element.
+     */
+    lastIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the content end's DOM element.
+     */
+    contentEnd?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Select component (jump to page dropdown).
+     */
+    pcJumpToPageDropdown?: SelectPassThrough;
+    /**
+     * Used to pass attributes to the InputNumber component (jump to page input).
+     */
+    pcJumpToPageInput?: InputNumberPassThrough;
+    /**
+     * Used to pass attributes to the Select component (rows per page dropdown).
+     */
+    pcRowPerPageDropdown?: SelectPassThrough;
+}
+/**
+ * Defines valid pass-through options in Paginator.
+ * @see {@link PaginatorPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PaginatorPassThrough<I = unknown> = PassThrough<I, PaginatorPassThroughOptions<I>>;
+/**
+ * Paginator state.
+ * @group Interface
+ */
+interface PaginatorState {
+    page?: number;
+    first?: number;
+    rows?: number;
+    pageCount?: number;
+}
+/**
+ * Defines valid templates in PaginatorTemplates.
+ * @group Templates
+ */
+interface PaginatorTemplates {
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    dropdownicon(): TemplateRef<any>;
+    /**
+     * Custom first page link icon template.
+     */
+    firstpagelinkicon(): TemplateRef<any>;
+    /**
+     * Custom previous page link icon template.
+     */
+    previouspagelinkicon(): TemplateRef<any>;
+    /**
+     * Custom last page link icon template.
+     */
+    lastpagelinkicon(): TemplateRef<any>;
+    /**
+     * Custom next page link icon template.
+     */
+    nextpagelinkicon(): TemplateRef<any>;
+}
+
+export type { PaginatorPassThrough, PaginatorPassThroughOptions, PaginatorState, PaginatorTemplates };

package/types/panel/index.d.ts

@@ -0,0 +1,92 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Panel.pt}
+ * @group Interface
+ */
+interface PanelPassThroughOptions<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<HTMLElement, 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 toggle button button's DOM element.
+     * @see {@link ButtonPassThroughOptions}
+     */
+    pcToggleButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the content container's DOM element.
+     */
+    contentContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * 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>;
+}
+/**
+ * Defines valid pass-through options in Panel component.
+ * @see {@link PanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PanelPassThrough<I = unknown> = PassThrough<I, PanelPassThroughOptions<I>>;
+/**
+ * Custom panel toggle event, emits before panel toggle.
+ * @see {@link onBeforeToggle}
+ * @group Interface
+ */
+interface PanelBeforeToggleEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Collapsed state of the panel.
+     */
+    collapsed: boolean | undefined;
+}
+/**
+ * Custom panel toggle event, emits after panel toggle.
+ * @see {@link onAfterToggle}
+ * @extends {PanelBeforeToggleEvent}
+ * @group Interface
+ */
+interface PanelAfterToggleEvent extends PanelBeforeToggleEvent {
+}
+/**
+ * Toggle icon template context.
+ * @param {boolean} $implicit - Collapsed state as a boolean, implicit value.
+ * @group Interface
+ */
+interface PanelHeaderIconsTemplateContext {
+    /**
+     * Collapsed state as a boolean, implicit value.
+     */
+    $implicit: boolean;
+}
+
+export type { PanelAfterToggleEvent, PanelBeforeToggleEvent, PanelHeaderIconsTemplateContext, PanelPassThrough, PanelPassThroughOptions };

package/types/panelmenu/index.d.ts

@@ -0,0 +1,114 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link PanelMenu.pt}
+ * @group Interface
+ */
+interface PanelMenuPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the panel's DOM element.
+     */
+    panel?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header content's DOM element.
+     */
+    headerContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header link's DOM element.
+     */
+    headerLink?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the submenu icon's DOM element.
+     */
+    submenuIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the header icon's DOM element.
+     */
+    headerIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the header label's DOM element.
+     */
+    headerLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the toggleable content's DOM element.
+     */
+    contentContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the menu content's DOM element.
+     */
+    content?: 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 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 separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, I>;
+}
+/**
+ * Defines valid pass-through options in PanelMenu.
+ * @see {@link PanelMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PanelMenuPassThrough<I = unknown> = PassThrough<I, PanelMenuPassThroughOptions<I>>;
+/**
+ * Defines valid templates in PanelMenu.
+ * @group Templates
+ */
+interface PanelMenuTemplates {
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: MenuItem;
+    }): TemplateRef<{
+        $implicit: MenuItem;
+    }>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<any>;
+}
+
+export type { PanelMenuPassThrough, PanelMenuPassThroughOptions, PanelMenuTemplates };

package/types/password/index.d.ts

@@ -0,0 +1,97 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { InputTextPassThrough } from 'primeng/types/inputtext';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Password.pt}
+ * @group Interface
+ */
+interface PasswordPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host element.
+     */
+    host?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the InputText component.
+     * @see {@link InputTextPassThrough}
+     */
+    pcInputText?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the mask icon's DOM element.
+     */
+    maskIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the unmask icon's DOM element.
+     */
+    unmaskIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the overlay's DOM element.
+     */
+    overlay?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter's DOM element.
+     */
+    meter?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter label's DOM element.
+     */
+    meterLabel?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter text's DOM element.
+     */
+    meterText?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Password.
+ * @see {@link PasswordPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PasswordPassThrough<I = unknown> = PassThrough<I, PasswordPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Password.
+ * @group Templates
+ */
+interface PasswordTemplates {
+    /**
+     * Custom template of header.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of footer.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom template of clear icon.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom template of hide icon.
+     */
+    hideicon(): TemplateRef<any>;
+    /**
+     * Custom template of show icon.
+     */
+    showicon(): TemplateRef<any>;
+}
+
+export type { PasswordPassThrough, PasswordPassThroughOptions, PasswordTemplates };