primeng 20.1.2 → 20.3.0-rc.1

package/types/tabs/index.d.ts

@@ -0,0 +1,119 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Defines valid pass-through options in Tabs component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabsPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tabs component.
+ * @see {@link TabsPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabsPassThrough<I = unknown> = PassThrough<I, TabsPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in TabList component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabListPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the previous button's DOM element.
+     */
+    prevButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the tab list's DOM element.
+     */
+    tabList?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the active bar's DOM element.
+     */
+    activeBar?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the next button's DOM element.
+     */
+    nextButton?: PassThroughOption<HTMLButtonElement, I>;
+}
+/**
+ * Defines valid pass-through options in TabList component.
+ * @see {@link TabListPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabListPassThrough<I = unknown> = PassThrough<I, TabListPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in Tab component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tab component.
+ * @see {@link TabPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabPassThrough<I = unknown> = PassThrough<I, TabPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in TabPanel component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabPanelPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in TabPanel component.
+ * @see {@link TabPanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabPanelPassThrough<I = unknown> = PassThrough<I, TabPanelPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in TabPanels component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabPanelsPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in TabPanels component.
+ * @see {@link TabPanelsPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabPanelsPassThrough<I = unknown> = PassThrough<I, TabPanelsPassThroughOptions<I>>;
+
+export type { TabListPassThrough, TabListPassThroughOptions, TabPanelPassThrough, TabPanelPassThroughOptions, TabPanelsPassThrough, TabPanelsPassThroughOptions, TabPassThrough, TabPassThroughOptions, TabsPassThrough, TabsPassThroughOptions };

package/types/tag/index.d.ts

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

package/types/terminal/index.d.ts

@@ -0,0 +1,60 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Terminal.pt}
+ * @group Interface
+ */
+interface TerminalPassThroughOptions<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 welcome message's DOM element.
+     */
+    welcomeMessage?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the command list's DOM element.
+     */
+    commandList?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the command's DOM element.
+     */
+    command?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the prompt label's DOM element.
+     */
+    promptLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the command value's DOM element.
+     */
+    commandValue?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the command response's DOM element.
+     */
+    commandResponse?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the prompt's DOM element.
+     */
+    prompt?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the prompt value's DOM element.
+     */
+    promptValue?: PassThroughOption<HTMLInputElement, I>;
+}
+/**
+ * Defines valid pass-through options in Terminal.
+ * @see {@link TerminalPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TerminalPassThrough<I = unknown> = PassThrough<I, TerminalPassThroughOptions<I>>;
+
+export type { TerminalPassThrough, TerminalPassThroughOptions };

package/types/textarea/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 Textarea.pt}
+ * @group Interface
+ */
+interface TextareaPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLTextAreaElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLTextAreaElement, I>;
+}
+/**
+ * Defines valid pass-through options in Textarea.
+ * @see {@link TextareaPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TextareaPassThrough<I = unknown> = PassThrough<I, TextareaPassThroughOptions<I>>;
+
+export type { TextareaPassThrough, TextareaPassThroughOptions };

package/types/tieredmenu/index.d.ts

@@ -0,0 +1,87 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link TieredMenu.pt}
+ * @group Interface
+ */
+interface TieredMenuPassThroughOptions<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 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<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, I>;
+}
+/**
+ * Defines valid pass-through options in TieredMenu.
+ * @see {@link TieredMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TieredMenuPassThrough<I = unknown> = PassThrough<I, TieredMenuPassThroughOptions<I>>;
+/**
+ * Defines valid templates in TieredMenu.
+ * @group Templates
+ */
+interface TieredMenuTemplates {
+    /**
+     * Custom template of item.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+        /**
+         * Submenu control of the item.
+         */
+        hasSubmenu: boolean;
+    }): TemplateRef<{
+        $implicit: any;
+        hasSubmenu: boolean;
+    }>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<any>;
+}
+
+export type { TieredMenuPassThrough, TieredMenuPassThroughOptions, TieredMenuTemplates };

package/types/timeline/index.d.ts

@@ -0,0 +1,95 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Timeline.pt}
+ * @group Interface
+ */
+interface TimelinePassThroughOptions<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 event's DOM element.
+     */
+    event?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event opposite's DOM element.
+     */
+    eventOpposite?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event separator's DOM element.
+     */
+    eventSeparator?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event marker's DOM element.
+     */
+    eventMarker?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event connector's DOM element.
+     */
+    eventConnector?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event content's DOM element.
+     */
+    eventContent?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Timeline.
+ * @see {@link TimelinePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TimelinePassThrough<I = unknown> = PassThrough<I, TimelinePassThroughOptions<I>>;
+/**
+ * Defines valid templates in Timeline.
+ * @group Templates
+ */
+interface TimelineTemplates {
+    /**
+     * Custom content template.
+     * @param {Object} context - item data.
+     */
+    content(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom opposite item template.
+     * @param {Object} context - item data.
+     */
+    opposite(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom marker template.
+     * @param {Object} context - item data.
+     */
+    marker(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+}
+
+export type { TimelinePassThrough, TimelinePassThroughOptions, TimelineTemplates };

package/types/toast/index.d.ts

@@ -0,0 +1,114 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, ToastMessageOptions } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options for Toast.
+ * @template I Type of instance.
+ *
+ * @see {@link Toast.pt}
+ * @group Interface
+ */
+interface ToastPassThroughOptions<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 message's DOM element.
+     */
+    message?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the message content's DOM element.
+     */
+    messageContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the message icon's DOM element.
+     */
+    messageIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message text's DOM element.
+     */
+    messageText?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the summary's DOM element.
+     */
+    summary?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the detail's DOM element.
+     */
+    detail?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the close button's DOM element.
+     */
+    closeButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the close icon's DOM element.
+     */
+    closeIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Toast.
+ * @see {@link ToastPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ToastPassThrough<I = unknown> = PassThrough<I, ToastPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Toast.
+ * @group Templates
+ */
+interface ToastTemplates {
+    /**
+     * Custom template of message.
+     */
+    message(context: {
+        /**
+         * Data of the message.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Headless template.
+     */
+    headless(context: {
+        /**
+         * Data of the message.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+}
+/**
+ * Defines the position type for Toast.
+ */
+type ToastPositionType = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'center';
+/**
+ * Custom close event.
+ * @see {@link Toast.onClose}
+ * @group Events
+ */
+interface ToastCloseEvent {
+    /**
+     * Message of the closed element.
+     */
+    message: ToastMessageOptions;
+}
+/**
+ * Custom close event.
+ * @see {@link ToastItem.onClose}
+ */
+interface ToastItemCloseEvent extends ToastCloseEvent {
+    /**
+     * Index of the closed element.
+     */
+    index: number;
+}
+
+export type { ToastCloseEvent, ToastItemCloseEvent, ToastPassThrough, ToastPassThroughOptions, ToastPositionType, ToastTemplates };

package/types/togglebutton/index.d.ts

@@ -0,0 +1,85 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ToggleButtonProps.pt}
+ * @group Interface
+ */
+interface ToggleButtonPassThroughOptions<I = unknown> {
+    /**
+     * 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<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>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type ToggleButtonPassThrough<I = unknown> = PassThrough<I, ToggleButtonPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link ToggleButton.onChange}
+ * @group Events
+ */
+interface ToggleButtonChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Checked state as a boolean.
+     */
+    checked: boolean;
+}
+/**
+ * Defines valid templates in ToggleButton.
+ * @group Templates
+ */
+interface ToggleButtonTemplates {
+    /**
+     * Custom icon template.
+     * @param {boolean} context - checked state as boolean.
+     */
+    icon(context: {
+        /**
+         * Checked.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom content template.
+     * @param {Object} context - content data.
+     */
+    content(context: {
+        /**
+         * Checked.
+         */
+        $implicit: boolean;
+        /**
+         * Label of the component.
+         */
+        label: string;
+    }): TemplateRef<{
+        $implicit: boolean | null;
+        label: string;
+    }>;
+}
+
+export type { ToggleButtonChangeEvent, ToggleButtonPassThrough, ToggleButtonPassThroughOptions, ToggleButtonTemplates };

package/types/toggleswitch/index.d.ts

@@ -0,0 +1,51 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom passthrough(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ToggleSwitch.pt}
+ * @group Interface
+ */
+interface ToggleSwitchPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the input's DOM element.
+     */
+    input?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the slider's DOM element.
+     */
+    slider?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the handle's DOM element.
+     */
+    handle?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in ToggleSwitch component.
+ * @see {@link ToggleSwitchPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ToggleSwitchPassThrough<I = unknown> = PassThrough<I, ToggleSwitchPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link ToggleSwitch.onChange}
+ * @group Events
+ */
+interface ToggleSwitchChangeEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Checked state as a boolean.
+     */
+    checked: boolean;
+}
+
+export type { ToggleSwitchChangeEvent, ToggleSwitchPassThrough, ToggleSwitchPassThroughOptions };