primeng 20.2.0 → 20.3.0-rc.1

package/types/accordion/index.d.ts

@@ -0,0 +1,88 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Defines valid pass-through options in Accordion component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface AccordionPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Accordion component.
+ * @see {@link AccordionPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type AccordionPassThrough<I = unknown> = PassThrough<I, AccordionPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in AccordionPanel component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface AccordionPanelPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the panel's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in AccordionPanel component.
+ * @see {@link AccordionPanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type AccordionPanelPassThrough<I = unknown> = PassThrough<I, AccordionPanelPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in AccordionHeader component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface AccordionHeaderPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the toggle icon's DOM element.
+     */
+    toggleicon?: PassThroughOption<SVGElement, I>;
+}
+/**
+ * Defines valid pass-through options in AccordionHeader component.
+ * @see {@link AccordionHeaderPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type AccordionHeaderPassThrough<I = unknown> = PassThrough<I, AccordionHeaderPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in AccordionContent component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface AccordionContentPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the content container's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in AccordionContent component.
+ * @see {@link AccordionContentPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type AccordionContentPassThrough<I = unknown> = PassThrough<I, AccordionContentPassThroughOptions<I>>;
+
+export type { AccordionContentPassThrough, AccordionContentPassThroughOptions, AccordionHeaderPassThrough, AccordionHeaderPassThroughOptions, AccordionPanelPassThrough, AccordionPanelPassThroughOptions, AccordionPassThrough, AccordionPassThroughOptions };

package/types/autocomplete/index.d.ts

@@ -0,0 +1,299 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, ScrollerOptions } from 'primeng/api';
+import { ChipPassThrough } from 'primeng/types/chip';
+import { InputTextPassThrough } from 'primeng/types/inputtext';
+import { OverlayPassThrough } from 'primeng/types/overlay';
+import { VirtualScrollerPassThrough } from 'primeng/types/scroller';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link AutoComplete.pt}
+ * @group Interface
+ */
+interface AutoCompletePassThroughOptions<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 InputText component.
+     * @see {@link InputTextPassThrough}
+     */
+    pcInputText?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the input multiple's DOM element.
+     */
+    inputMultiple?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the chip item's DOM element.
+     */
+    chipItem?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the Chip component.
+     * @see {@link ChipPassThrough}
+     */
+    pcChip?: ChipPassThrough;
+    /**
+     * Used to pass attributes to the chip icon's DOM element.
+     */
+    chipIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the input chip's DOM element.
+     */
+    inputChip?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the loader's DOM element.
+     */
+    loader?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the dropdown button's DOM element.
+     */
+    dropdown?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the Overlay component.
+     * @see {@link OverlayPassThrough}
+     */
+    pcOverlay?: OverlayPassThrough;
+    /**
+     * Used to pass attributes to the overlay's DOM element.
+     */
+    overlay?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the list container's DOM element.
+     */
+    listContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Scroller component.
+     * @see {@link VirtualScrollerPassThrough}
+     */
+    pcScroller?: VirtualScrollerPassThrough;
+    /**
+     * Used to pass attributes to the list's DOM element.
+     */
+    list?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the option group's DOM element.
+     */
+    optionGroup?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the option's DOM element.
+     */
+    option?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLLIElement, I>;
+}
+/**
+ * Defines valid pass-through options in AutoComplete.
+ * @see {@link AutoCompletePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type AutoCompletePassThrough<I = unknown> = PassThrough<I, AutoCompletePassThroughOptions<I>>;
+/**
+ * Custom complete event.
+ * @see {@link AutoComplete.completeMethod}
+ * @group Events
+ */
+interface AutoCompleteCompleteEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value.
+     */
+    query: string;
+}
+/**
+ * Custom click event.
+ * @see {@link AutoComplete.onDropdownClick}
+ * @group Events
+ */
+interface AutoCompleteDropdownClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value.
+     */
+    query?: string;
+}
+/**
+ * Custom select event.
+ * @see {@link AutoComplete.onSelect}
+ * @group Events
+ */
+interface AutoCompleteSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected value.
+     */
+    value: any;
+}
+/**
+ * Custom unselect event.
+ * @see {@link AutoComplete.onUnSelect}
+ * @group Events
+ */
+interface AutoCompleteUnselectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Removed value.
+     */
+    value: any;
+}
+/**
+ * Custom add event.
+ * @see {@link AutoComplete.onAdd}
+ * @group Events
+ */
+interface AutoCompleteAddEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Added value.
+     */
+    value: any;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link AutoComplete.onLazyLoad}
+ * @group Events
+ */
+interface AutoCompleteLazyLoadEvent {
+    /**
+     * First element in viewport.
+     */
+    first: any;
+    /**
+     * Last element in viewport.
+     */
+    last: any;
+}
+/**
+ * Defines valid templates in AutoComplete.
+ * @group Templates
+ */
+interface AutoCompleteTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - option data.
+     */
+    item(context: {
+        /**
+         * Option.
+         */
+        $implicit: any;
+        /**
+         * Option index.
+         */
+        index: number;
+    }): TemplateRef<{
+        $implicit: any;
+        index: number;
+    }>;
+    /**
+     * Custom group template.
+     * @param {Object} context - group data.
+     */
+    group(context: {
+        /**
+         * Option group.
+         */
+        $implicit: any | any[];
+    }): TemplateRef<{
+        $implicit: any | any[];
+    }>;
+    /**
+     * Custom selected item template, only supported in multiple mode.
+     * @param {Object} context - selected item data.
+     */
+    selectedItem(context: {
+        /**
+         * Selected value.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implici: any;
+    }>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom loader template.
+     * @param {Object} context - scroller options.
+     */
+    loader(context: {
+        /**
+         * Virtual scroller options.
+         */
+        $implicit: ScrollerOptions;
+    }): TemplateRef<{
+        $implicit: ScrollerOptions;
+    }>;
+    /**
+     * Custom remove icon template.
+     */
+    removeicon(context: {
+        /**
+         * Class of the removeicon.
+         */
+        class: string;
+        /**
+         * Remove callback.
+         */
+        removeCallback: (event: Event, index: number) => void;
+        /**
+         * Option index.
+         */
+        index: number;
+    }): TemplateRef<{
+        class: string;
+        removeCallback: (event: Event, index: number) => void;
+        index: number;
+    }>;
+    /**
+     * Custom loading icon template.
+     */
+    loadingicon(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom dropdown icon template.
+     */
+    dropdownicon(): TemplateRef<any>;
+}
+
+export type { AutoCompleteAddEvent, AutoCompleteCompleteEvent, AutoCompleteDropdownClickEvent, AutoCompleteLazyLoadEvent, AutoCompletePassThrough, AutoCompletePassThroughOptions, AutoCompleteSelectEvent, AutoCompleteTemplates, AutoCompleteUnselectEvent };

package/types/avatar/index.d.ts

@@ -0,0 +1,40 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Avatar.pt}
+ * @group Interface
+ */
+interface AvatarPassThroughOptions<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 label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the image's DOM element.
+     */
+    image?: PassThroughOption<HTMLImageElement, I>;
+}
+/**
+ * Defines valid pass-through options in Avatar component.
+ * @see {@link AvatarPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type AvatarPassThrough<I = unknown> = PassThrough<I, AvatarPassThroughOptions<I>>;
+
+export type { AvatarPassThrough, AvatarPassThroughOptions };

package/types/avatargroup/index.d.ts

@@ -0,0 +1,28 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link AvatarGroupProps.pt}
+ * @group Interface
+ */
+interface AvatarGroupPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in AvatarGroup.
+ * @see {@link AvatarGroupPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type AvatarGroupPassThrough<I = unknown> = PassThrough<I, AvatarGroupPassThroughOptions<I>>;
+
+export type { AvatarGroupPassThrough, AvatarGroupPassThroughOptions };

package/types/badge/index.d.ts

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

package/types/blockui/index.d.ts

@@ -0,0 +1,39 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link BlockUI.pt}
+ * @group Interface
+ */
+interface BlockUIPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in BlockUI component.
+ * @see {@link BlockUIPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type BlockUIPassThrough<I = unknown> = PassThrough<I, BlockUIPassThroughOptions<I>>;
+/**
+ * Defines valid templates in BlockUI.
+ * @group Templates
+ */
+interface BlockUITemplates {
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+}
+
+export type { BlockUIPassThrough, BlockUIPassThroughOptions, BlockUITemplates };

package/types/breadcrumb/index.d.ts

@@ -0,0 +1,70 @@
+import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Breadcrumb.pt}
+ * @group Interface
+ */
+interface BreadcrumbPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the list's DOM element.
+     */
+    list?: PassThroughOption<HTMLOListElement, I>;
+    /**
+     * Used to pass attributes to the home item's DOM element.
+     */
+    homeItem?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLLIElement, 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 | SVGElement, 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>;
+    /**
+     * Used to pass attributes to the separator icon's DOM element.
+     */
+    separatorIcon?: PassThroughOption<SVGElement, I>;
+}
+/**
+ * Defines valid pass-through options in Breadcrumb.
+ * @see {@link BreadcrumbPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type BreadcrumbPassThrough<I = unknown> = PassThrough<I, BreadcrumbPassThroughOptions<I>>;
+/**
+ * Defines clicked item event.
+ * @see {@link BreadcrumbEmitsOptions.itemClick}
+ */
+interface BreadcrumbItemClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Clicked item instance.
+     */
+    item: MenuItem;
+}
+
+export type { BreadcrumbItemClickEvent, BreadcrumbPassThrough, BreadcrumbPassThroughOptions };

package/types/button/index.d.ts

@@ -0,0 +1,105 @@
+import { NgClass } from '@angular/common';
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { BadgePassThrough } from 'primeng/types/badge';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Button.pt}
+ * @group Interface
+ */
+interface ButtonPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the Badge component.
+     */
+    pcBadge?: BadgePassThrough;
+}
+/**
+ * Defines valid pass-through options in Button component.
+ * @see {@link ButtonPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ButtonPassThrough<I = unknown> = PassThrough<I, ButtonPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Button.
+ * @group Templates
+ */
+interface ButtonTemplates {
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of icon.
+     */
+    icon(context: {
+        /**
+         * Icon class.
+         */
+        class: NgClass;
+    }): TemplateRef<NgClass>;
+    /**
+     * Custom template of loadingicon.
+     */
+    loadingicon(context: {
+        /**
+         * Icon class.
+         */
+        class: NgClass;
+    }): TemplateRef<NgClass>;
+}
+type ButtonIconPosition = 'left' | 'right' | 'top' | 'bottom';
+interface ButtonProps {
+    type?: string;
+    iconPos?: ButtonIconPosition;
+    icon?: string | undefined;
+    badge?: string | undefined;
+    label?: string | undefined;
+    disabled?: boolean | undefined;
+    loading?: boolean;
+    loadingIcon?: string | undefined;
+    raised?: boolean;
+    rounded?: boolean;
+    text?: boolean;
+    plain?: boolean;
+    severity?: ButtonSeverity;
+    outlined?: boolean;
+    link?: boolean;
+    tabindex?: number | undefined;
+    size?: 'small' | 'large' | undefined;
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    styleClass?: string | undefined;
+    badgeClass?: string | undefined;
+    badgeSeverity?: 'success' | 'info' | 'warning' | 'danger' | 'help' | 'primary' | 'secondary' | 'contrast' | null | undefined;
+    ariaLabel?: string | undefined;
+    autofocus?: boolean | undefined;
+    variant?: string | undefined;
+}
+type ButtonSeverity = 'success' | 'info' | 'warn' | 'danger' | 'help' | 'primary' | 'secondary' | 'contrast' | null | undefined;
+
+export type { ButtonPassThrough, ButtonPassThroughOptions, ButtonProps, ButtonSeverity, ButtonTemplates };