primeng 20.2.0 → 20.3.0-rc.1

package/types/scroller/index.d.ts

@@ -0,0 +1,221 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Scroller.pt}
+ * @group Interface
+ */
+interface VirtualScrollerPassThroughOptions<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 spacer's DOM element.
+     */
+    spacer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loader's DOM element.
+     */
+    loader?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in VirtualScroller.
+ * @see {@link VirtualScrollerPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type VirtualScrollerPassThrough<I = unknown> = PassThrough<I, VirtualScrollerPassThroughOptions<I>>;
+/**
+ * Options of the scroll direction.
+ * @group Types
+ */
+type ScrollerToType = 'to-start' | 'to-end' | undefined;
+/**
+ * Options of the scroller orientation.
+ * @group Types
+ */
+type VirtualScrollerOrientationType = 'vertical' | 'horizontal' | 'both';
+/**
+ * Loader icon options.
+ * @group Types
+ */
+interface ScrollerLoaderIconOptions {
+    [klass: string]: any;
+}
+/**
+ * Scroller content options.
+ * @group Interface
+ */
+interface ScrollerContentOptions {
+    contentStyleClass?: string;
+    items?: any[];
+    loading?: boolean;
+    itemSize?: number;
+    rows?: any[];
+    columns?: any[];
+    spacerStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    contentStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    vertical?: boolean;
+    horizontal?: boolean;
+    both?: boolean;
+    getItemOptions?: (index: number) => ScrollerItemOptions;
+    getLoaderOptions?: (index: number, options?: any) => ScrollerLoaderOptions;
+}
+/**
+ * Scroller item options.
+ * @group Interface
+ */
+interface ScrollerItemOptions {
+    /**
+     * Index of the item.
+     */
+    index?: number;
+    /**
+     * Item count.
+     */
+    count?: number;
+    /**
+     * Index of the first element in viewport.
+     */
+    first?: boolean;
+    /**
+     * Index of the last element in viewport.
+     */
+    last?: boolean;
+    /**
+     * Defines if index is even number.
+     */
+    even?: boolean;
+    /**
+     * Defines if index is odd number.
+     */
+    odd?: boolean;
+}
+/**
+ * Loader settings.
+ * @extends {ScrollerItemOptions}
+ * @group Interface
+ */
+interface ScrollerLoaderOptions extends ScrollerItemOptions {
+    [klass: string]: any;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Scroller.onLazyLoad}
+ * @group Events
+ */
+interface ScrollerLazyLoadEvent {
+    /**
+     * First element index in viewport.
+     */
+    first: number;
+    /**
+     * Last element index in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom scroll index change event.
+ * @see {@link Scroller.onScrollIndexChange}
+ * @extends {ScrollerLazyLoadEvent}
+ * @group Events
+ */
+interface ScrollerScrollIndexChangeEvent extends ScrollerLazyLoadEvent {
+}
+/**
+ * Custom scroll event.
+ * @see {@link Scroller.onScroll}
+ * @group Events
+ */
+interface ScrollerScrollEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Defines valid templates in Scroller.
+ * @group Templates
+ */
+interface ScrollerTemplates {
+    /**
+     * Custom content template.
+     * @param {Object} context - Content data.
+     */
+    content(context: {
+        /**
+         * Loaded items.
+         */
+        $implicit: any[] | any | null | undefined;
+        /**
+         *
+         */
+        options: ScrollerContentOptions;
+    }): TemplateRef<{
+        $implicit: any[] | any | null | undefined;
+        options: ScrollerContentOptions;
+    }>;
+    /**
+     * Custom item template.
+     * @param {Object} context - Item data.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+        /**
+         * Scroller item options.
+         */
+        options: ScrollerItemOptions;
+    }): TemplateRef<{
+        $implicit: any;
+        options: ScrollerItemOptions;
+    }>;
+    /**
+     * Custom loader template.
+     * @param {Object} context - Options instance.
+     */
+    loader(context: {
+        /**
+         * Options.
+         */
+        options: ScrollerLoaderOptions;
+    }): TemplateRef<{
+        options: ScrollerLoaderOptions;
+    }>;
+    /**
+     * Custom loader icon template.
+     * @param {Object} context - Icon options.
+     */
+    loadericon(context: {
+        /**
+         * Options.
+         */
+        options: ScrollerLoaderIconOptions;
+    }): TemplateRef<{
+        options: ScrollerLoaderIconOptions;
+    }>;
+}
+
+export type { ScrollerContentOptions, ScrollerItemOptions, ScrollerLazyLoadEvent, ScrollerLoaderIconOptions, ScrollerLoaderOptions, ScrollerScrollEvent, ScrollerScrollIndexChangeEvent, ScrollerTemplates, ScrollerToType, VirtualScrollerOrientationType, VirtualScrollerPassThrough, VirtualScrollerPassThroughOptions };

package/types/scrollpanel/index.d.ts

@@ -0,0 +1,51 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ScrollPanel.pt}
+ * @group Interface
+ */
+interface ScrollPanelPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * 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 horizontal panel's DOM element.
+     */
+    barX?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the vertical panel's DOM element.
+     */
+    barY?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in ScrollPanel component.
+ * @see {@link ScrollPanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ScrollPanelPassThrough<I = unknown> = PassThrough<I, ScrollPanelPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ScrollPanel.
+ * @group Templates
+ */
+interface ScrollPanelTemplates {
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<any>;
+}
+
+export type { ScrollPanelPassThrough, ScrollPanelPassThroughOptions, ScrollPanelTemplates };

package/types/scrolltop/index.d.ts

@@ -0,0 +1,52 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ScrollTop.pt}
+ * @group Interface
+ */
+interface ScrollTopPassThroughOptions<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 Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcButton?: ButtonPassThrough;
+}
+/**
+ * Defines valid pass-through options in ScrollTop.
+ * @see {@link ScrollTopPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ScrollTopPassThrough<I = unknown> = PassThrough<I, ScrollTopPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ScrollTop.
+ * @group Templates
+ */
+interface ScrollTopTemplates {
+    /**
+     * Icon of the component.
+     */
+    icon(context: {
+        /**
+         * Style class of the icon.
+         */
+        styleClass: string;
+    }): TemplateRef<{
+        styleClass: string;
+    }>;
+}
+
+export type { ScrollTopPassThrough, ScrollTopPassThroughOptions, ScrollTopTemplates };

package/types/select/index.d.ts

@@ -0,0 +1,288 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, ScrollerOptions } from 'primeng/api';
+import { IconFieldPassThrough } from 'primeng/types/iconfield';
+import { InputIconPassThrough } from 'primeng/types/inputicon';
+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 Select.pt}
+ * @group Interface
+ */
+interface SelectPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement | HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the dropdown's DOM element.
+     */
+    dropdown?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the dropdown icon's DOM element.
+     */
+    dropdownIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Overlay component.
+     * @see {@link OverlayPassThrough}
+     */
+    pcOverlay?: OverlayPassThrough;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the filter container's DOM element.
+     */
+    pcFilterContainer?: IconFieldPassThrough;
+    /**
+     * Used to pass attributes to the filter input's DOM element.
+     */
+    pcFilter?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the filter icon container's DOM element.
+     */
+    pcFilterIconContainer?: InputIconPassThrough;
+    /**
+     * Used to pass attributes to the filter icon's DOM element.
+     */
+    filterIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the list container's DOM element.
+     */
+    listContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the VirtualScroller component.
+     * @see {@link ScrollerOptions}
+     */
+    virtualScroller?: 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 group label's DOM element.
+     */
+    optionGroupLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the option's DOM element.
+     */
+    option?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the option check icon's DOM element.
+     */
+    optionCheckIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the option blank icon's DOM element.
+     */
+    optionBlankIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the option label's DOM element.
+     */
+    optionLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the hidden first focusable element's DOM element.
+     */
+    hiddenFirstFocusableEl?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden filter result's DOM element.
+     */
+    hiddenFilterResult?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden empty message's DOM element.
+     */
+    hiddenEmptyMessage?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden selected message's DOM element.
+     */
+    hiddenSelectedMessage?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden last focusable element's DOM element.
+     */
+    hiddenLastFocusableEl?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in Select component.
+ * @see {@link SelectPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SelectPassThrough<I = unknown> = PassThrough<I, SelectPassThroughOptions<I>>;
+/**
+ * Filter callbacks of the select.
+ * @group Interface
+ */
+interface SelectFilterOptions {
+    /**
+     * Filter function.
+     */
+    filter?: (value?: any) => void;
+    /**
+     * Reset function.
+     */
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link Select.onChange}
+ * @group Events
+ */
+interface SelectChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option value
+     */
+    value: any;
+}
+/**
+ * Custom filter event.
+ * @see {@link Select.onFilter}
+ * @group Events
+ */
+interface SelectFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filter value.
+     */
+    filter: any;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Select.onLazyLoad}
+ * @group Events
+ */
+interface SelectLazyLoadEvent {
+    /**
+     * Index of the first element in viewport.
+     */
+    first: number;
+    /**
+     * Index of the last element in viewport.
+     */
+    last: number;
+}
+/**
+ * Defines valid templates in Select.
+ * @group Templates
+ */
+interface SelectTemplates {
+    /**
+     * Custom item 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 {SelectFilterOptions} options - filter options.
+     */
+    filter(context: {
+        /**
+         * Filter options.
+         */
+        options: SelectFilterOptions;
+    }): TemplateRef<{
+        options: SelectFilterOptions;
+    }>;
+    /**
+     * 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 select icon template.
+     */
+    dropdownicon(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+}
+
+export type { SelectChangeEvent, SelectFilterEvent, SelectFilterOptions, SelectLazyLoadEvent, SelectPassThrough, SelectPassThroughOptions, SelectTemplates };

package/types/selectbutton/index.d.ts

@@ -0,0 +1,77 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ToggleButtonPassThrough } from 'primeng/types/togglebutton';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link SelectButton.pt}
+ * @group Interface
+ */
+interface SelectButtonPassThroughOptions<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 ToggleButton component.
+     * @see {@link ToggleButtonPassThrough}
+     */
+    pcToggleButton?: ToggleButtonPassThrough;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type SelectButtonPassThrough<I = unknown> = PassThrough<I, SelectButtonPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link SelectButton.onChange}
+ * @group Events
+ */
+interface SelectButtonChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option.
+     */
+    value?: any;
+}
+/**
+ * Custom option click event.
+ * @see {@link SelectButton.onOptionClick}
+ * @group Events
+ */
+interface SelectButtonOptionClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option.
+     */
+    option?: any;
+    /**
+     * Index of the selected option.
+     */
+    index?: number;
+}
+/**
+ * Defines valid templates in SelectButton.
+ * @group Templates
+ */
+interface SelectButtonTemplates {
+    /**
+     * Custom item template.
+     */
+    item(): TemplateRef<any>;
+}
+
+export type { SelectButtonChangeEvent, SelectButtonOptionClickEvent, SelectButtonPassThrough, SelectButtonPassThroughOptions, SelectButtonTemplates };

package/types/skeleton/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 Skeleton.pt}
+ * @group Interface
+ */
+interface SkeletonPassThroughOptions<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 Skeleton.
+ * @see {@link SkeletonPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SkeletonPassThrough<I = unknown> = PassThrough<I, SkeletonPassThroughOptions<I>>;
+
+export type { SkeletonPassThrough, SkeletonPassThroughOptions };