primeng 20.2.0 → 20.3.0-rc.1

package/types/inputmask/index.d.ts

@@ -0,0 +1,56 @@
+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 InputMask.pt}
+ * @group Interface
+ */
+interface InputMaskPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the InputText component.
+     */
+    pcInputText?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputMask.
+ * @see {@link InputMaskPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InputMaskPassThrough<I = unknown> = PassThrough<I, InputMaskPassThroughOptions<I>>;
+/**
+ * Caret positions.
+ * @group Types
+ */
+type Caret = {
+    begin: number;
+    end: number;
+};
+/**
+ * Defines valid templates in InputMask.
+ * @group Templates
+ */
+interface InputMaskTemplates {
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+}
+
+export type { Caret, InputMaskPassThrough, InputMaskPassThroughOptions, InputMaskTemplates };

package/types/inputnumber/index.d.ts

@@ -0,0 +1,95 @@
+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 InputNumber.pt}
+ * @group Interface
+ */
+interface InputNumberPassThroughOptions<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.
+     */
+    pcInputText?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the button group's DOM element.
+     */
+    buttonGroup?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the increment button's DOM element.
+     */
+    incrementButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the decrement button's DOM element.
+     */
+    decrementButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the increment button icon's DOM element.
+     */
+    incrementButtonIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the decrement button icon's DOM element.
+     */
+    decrementButtonIcon?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputNumber component.
+ * @see {@link InputNumberPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InputNumberPassThrough<I = unknown> = PassThrough<I, InputNumberPassThroughOptions<I>>;
+/**
+ * Custom InputNumber input event.
+ * @see {@link onInput}
+ * @group Interface
+ */
+interface InputNumberInputEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Input value.
+     */
+    value: number | null;
+    /**
+     * Formatted value.
+     */
+    formattedValue: string;
+}
+/**
+ * Defines valid templates in InputNumber.
+ * @group Templates
+ */
+interface InputNumberTemplates {
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom increment button icon template.
+     */
+    incrementbuttonicon(): TemplateRef<any>;
+    /**
+     * Custom decrement button icon template.
+     */
+    decrementbuttonicon(): TemplateRef<any>;
+}
+
+export type { InputNumberInputEvent, InputNumberPassThrough, InputNumberPassThroughOptions, InputNumberTemplates };

package/types/inputotp/index.d.ts

@@ -0,0 +1,31 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { InputTextPassThrough } from 'primeng/types/inputtext';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputOtp.pt}
+ * @group Interface
+ */
+interface InputOtpPassThroughOptions<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 InputText component.
+     */
+    pcInputText?: InputTextPassThrough;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type InputOtpPassThrough<I = unknown> = PassThrough<I, InputOtpPassThroughOptions<I>>;
+
+export type { InputOtpPassThrough, InputOtpPassThroughOptions };

package/types/inputtext/index.d.ts

@@ -0,0 +1,24 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputTextPassThrough}
+ * @group Interface
+ */
+interface InputTextPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLInputElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputText.
+ * @see {@link InputTextPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InputTextPassThrough<I = unknown> = PassThrough<I, InputTextPassThroughOptions<I>>;
+
+export type { InputTextPassThrough, InputTextPassThroughOptions };

package/types/knob/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 Knob.pt}
+ * @group Interface
+ */
+interface KnobPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the SVG's DOM element.
+     */
+    svg?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the range's DOM element.
+     */
+    range?: PassThroughOption<SVGPathElement, I>;
+    /**
+     * Used to pass attributes to the value's DOM element.
+     */
+    value?: PassThroughOption<SVGPathElement, I>;
+    /**
+     * Used to pass attributes to the text's DOM element.
+     */
+    text?: PassThroughOption<SVGTextElement, I>;
+}
+/**
+ * Defines valid pass-through options in Knob component.
+ * @see {@link KnobPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type KnobPassThrough<I = unknown> = PassThrough<I, KnobPassThroughOptions<I>>;
+
+export type { KnobPassThrough, KnobPassThroughOptions };

package/types/listbox/index.d.ts

@@ -0,0 +1,280 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Defines valid pass-through options in ListBox component.
+ * @template I Type of instance.
+ *
+ * @see {@link Listbox.pt}
+ * @group Interface
+ */
+interface ListBoxPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Checkbox component.
+     */
+    pcCheckbox?: any;
+    /**
+     * Used to pass attributes to the IconField component.
+     */
+    pcFilterContainer?: any;
+    /**
+     * Used to pass attributes to the filter input's DOM element.
+     */
+    pcFilter?: any;
+    /**
+     * Used to pass attributes to the InputIcon component.
+     */
+    pcFilterIconContainer?: any;
+    /**
+     * Used to pass attributes to the filter icon's DOM element.
+     */
+    filterIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the hidden filter result's DOM element.
+     */
+    hiddenFilterResult?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the list container's DOM element.
+     */
+    listContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the VirtualScroller component.
+     */
+    virtualScroller?: any;
+    /**
+     * 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, ListBoxContext>;
+    /**
+     * Used to pass attributes to the option's DOM element.
+     */
+    option?: PassThroughOption<HTMLLIElement, I, ListBoxContext>;
+    /**
+     * Used to pass attributes to the option check icon's DOM element.
+     */
+    optionCheckIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the option blank icon's DOM element.
+     */
+    optionBlankIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLLIElement, 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 first hidden focusable element.
+     */
+    hiddenFirstFocusableEl?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the last hidden focusable element.
+     */
+    hiddenLastFocusableEl?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in ListBox component.
+ * @see {@link ListBoxPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ListBoxPassThrough<I = unknown> = PassThrough<I, ListBoxPassThroughOptions<I>>;
+/**
+ * Filter options of listbox.
+ * @group Interface
+ */
+interface ListboxFilterOptions {
+    /**
+     * Callback to filter options.
+     * @param {any} value - Filter value.
+     */
+    filter?: (value?: any) => void;
+    /**
+     * Callback to reset filter.
+     */
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @group Events
+ */
+interface ListboxChangeEvent {
+    /**
+     * Original event
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value
+     */
+    value: any;
+}
+/**
+ * Custom change event.
+ * @group Events
+ */
+interface ListboxSelectAllChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Boolean value indicates whether all data is selected.
+     */
+    checked: boolean;
+}
+/**
+ * Custom filter event.
+ * @group Events
+ */
+interface ListboxFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filter value.
+     */
+    filter: any;
+}
+/**
+ * Custom change event.
+ * @group Events
+ */
+interface ListboxClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Value of the component.
+     */
+    value: any;
+    /**
+     * Selected option
+     */
+    option?: any;
+}
+/**
+ * Custom change event.
+ * @group Events
+ */
+interface ListboxDoubleClickEvent extends ListboxClickEvent {
+}
+/**
+ * Defines valid templates in Panel.
+ * @group Templates
+ */
+interface ListboxTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Data of the option.
+         */
+        $implicit: any;
+        /**
+         * Index of the option.
+         */
+        index: number;
+    }): TemplateRef<{
+        $implicit: any;
+        index: number;
+    }>;
+    /**
+     * Custom group template.
+     * @param {Object} context - group data.
+     */
+    group(context: {
+        /**
+         * Group option.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom filter template.
+     * @param {Object} context - filter options.
+     */
+    filter(context: {
+        /**
+         * Filter options.
+         */
+        options: ListboxFilterOptions;
+    }): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom empty filter template.
+     */
+    emptyfilter(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+    /**
+     * Custom check icon template.
+     */
+    checkicon(): TemplateRef<any>;
+    /**
+     * Custom checkmark template.
+     */
+    checkmark(context: {
+        /**
+         * Selection status.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+}
+/**
+ * Defines context options for ListBox passthrough.
+ * @group Interface
+ */
+interface ListBoxContext {
+    /**
+     * Whether the option is selected.
+     */
+    selected?: boolean;
+    /**
+     * Whether the option is focused.
+     */
+    focused?: boolean;
+    /**
+     * Whether the option is disabled.
+     */
+    disabled?: boolean;
+}
+
+export type { ListBoxContext, ListBoxPassThrough, ListBoxPassThroughOptions, ListboxChangeEvent, ListboxClickEvent, ListboxDoubleClickEvent, ListboxFilterEvent, ListboxFilterOptions, ListboxSelectAllChangeEvent, ListboxTemplates };

package/types/megamenu/index.d.ts

@@ -0,0 +1,122 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link MegaMenu.pt}
+ * @group Interface
+ */
+interface MegaMenuPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the start's DOM element.
+     */
+    start?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the button's DOM element.
+     */
+    button?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the button icon's DOM element.
+     */
+    buttonIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root list's DOM element.
+     */
+    rootList?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the submenu label's DOM element.
+     */
+    submenuLabel?: PassThroughOption<HTMLLIElement, 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<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the overlay's DOM element.
+     */
+    overlay?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the grid's DOM element.
+     */
+    grid?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the column's DOM element.
+     */
+    column?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the submenu's DOM element.
+     */
+    submenu?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the end's DOM element.
+     */
+    end?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in MegaMenu.
+ * @see {@link MegaMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MegaMenuPassThrough<I = unknown> = PassThrough<I, MegaMenuPassThroughOptions<I>>;
+/**
+ * Defines valid templates in MegaMenu.
+ * @group Templates
+ */
+interface MegaMenuTemplates {
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: MenuItem;
+    }): TemplateRef<{
+        $implicit: MenuItem;
+    }>;
+    /**
+     * Custom template of start.
+     */
+    start(): TemplateRef<any>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<any>;
+    /**
+     * Custom template of end.
+     */
+    end(): TemplateRef<any>;
+}
+
+export type { MegaMenuPassThrough, MegaMenuPassThroughOptions, MegaMenuTemplates };