primeng 20.1.2 → 20.3.0-rc.1

package/types/menu/index.d.ts

@@ -0,0 +1,101 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Menu.pt}
+ * @group Interface
+ */
+interface MenuPassThroughOptions<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 list's DOM element.
+     */
+    list?: 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 end's DOM element.
+     */
+    end?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Menu.
+ * @see {@link MenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MenuPassThrough<I = unknown> = PassThrough<I, MenuPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Menu.
+ * @group Templates
+ */
+interface MenuTemplates {
+    /**
+     * Custom template of start.
+     */
+    start(): TemplateRef<any>;
+    /**
+     * Custom template of end.
+     */
+    end(): TemplateRef<any>;
+    /**
+     * Custom template of item.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: MenuItem;
+    }): TemplateRef<{
+        $implicit: MenuItem;
+    }>;
+    /**
+     * Custom template of submenuheader.
+     */
+    submenuheader(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: MenuItem;
+    }): TemplateRef<{
+        $implicit: MenuItem;
+    }>;
+}
+
+export type { MenuPassThrough, MenuPassThroughOptions, MenuTemplates };

package/types/menubar/index.d.ts

@@ -0,0 +1,121 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
+import { BadgePassThrough } from 'primeng/types/badge';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Menubar.pt}
+ * @group Interface
+ */
+interface MenubarPassThroughOptions<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 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<SVGElement, I>;
+    /**
+     * Used to pass attributes to the separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the mobile menu button's DOM element.
+     */
+    button?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the mobile menu button icon's DOM element.
+     */
+    buttonIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the submenu's DOM element.
+     */
+    submenu?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the start of the component.
+     */
+    start?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the end of the component.
+     */
+    end?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to Badge component.
+     * @see {@link BadgePassThrough}
+     */
+    pcBadge?: BadgePassThrough;
+}
+/**
+ * Defines valid pass-through options in Menubar.
+ * @see {@link MenubarPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MenubarPassThrough<I = unknown> = PassThrough<I, MenubarPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Menubar.
+ * @group Templates
+ */
+interface MenubarTemplates {
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: MenuItem;
+        /**
+         * Whether root or not
+         */
+        root: boolean;
+    }): TemplateRef<{
+        $implicit: MenuItem;
+        root: boolean;
+    }>;
+    /**
+     * Custom template of start.
+     */
+    start(): TemplateRef<any>;
+    /**
+     * Custom template of end.
+     */
+    end(): TemplateRef<any>;
+    /**
+     * Custom template of menuicon.
+     */
+    menuicon(): TemplateRef<any>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<any>;
+}
+
+export type { MenubarPassThrough, MenubarPassThroughOptions, MenubarTemplates };

package/types/message/index.d.ts

@@ -0,0 +1,48 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Message.pt}
+ * @group Interface
+ */
+interface MessagePassThroughOptions<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 icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the text's DOM element.
+     */
+    text?: PassThroughOption<HTMLSpanElement, 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 Message.
+ * @see {@link MessagePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MessagePassThrough<I = unknown> = PassThrough<I, MessagePassThroughOptions<I>>;
+
+export type { MessagePassThrough, MessagePassThroughOptions };

package/types/metergroup/index.d.ts

@@ -0,0 +1,178 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link MeterGroup.pt}
+ * @group Interface
+ */
+interface MeterGroupPassThroughOptions<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 meters' DOM element.
+     */
+    meters?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter's DOM element.
+     */
+    meter?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label list's DOM element.
+     */
+    labelList?: PassThroughOption<HTMLOListElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the label icon's DOM element.
+     */
+    labelIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the label marker's DOM element.
+     */
+    labelMarker?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label text's DOM element.
+     */
+    labelText?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in MeterGroup.
+ * @see {@link MeterGroupPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MeterGroupPassThrough<I = unknown> = PassThrough<I, MeterGroupPassThroughOptions<I>>;
+/**
+ * Defines valid templates in MeterGroup.
+ * @group Templates
+ */
+interface MeterGroupTemplates {
+    /**
+     * Custom label template.
+     */
+    label(context: {
+        /**
+         * Current value of the component.
+         */
+        $implicit?: MeterItem;
+        /**
+         * Total percent of the metergroup items.
+         */
+        totalPercent?: number;
+        /**
+         * Array of sequential sum of values of metergroup items.
+         */
+        percentages?: number;
+    }): TemplateRef<any>;
+    /**
+     * Custom meter item template.
+     */
+    meter(context: {
+        /**
+         * Current value of the component.
+         */
+        $implicit?: MeterItem;
+        /**
+         * Current index of the meter item.
+         */
+        index?: number;
+        /**
+         * Style class of the meter item
+         */
+        class?: string;
+        /**
+         * Current orientation of the component.
+         */
+        orientation?: string;
+        /**
+         * Current width of the meter item.
+         */
+        size?: string;
+        /**
+         * Total percent of the metergroup items
+         */
+        totalPercent?: number;
+    }): TemplateRef<any>;
+    /**
+     * Custom start template.
+     */
+    start(context: {
+        /**
+         * Current value of the component.
+         */
+        $implicit?: MeterItem;
+        /**
+         * Total percent of the metergroup items.
+         */
+        totalPercent?: number;
+        /**
+         * Array of sequential sum of values of metergroup items.
+         */
+        percentages?: number;
+    }): TemplateRef<any>;
+    /**
+     * Custom start template.
+     */
+    end(context: {
+        /**
+         * Current value of the component.
+         */
+        $implicit?: MeterItem;
+        /**
+         * Total percent of the metergroup items.
+         */
+        totalPercent?: number;
+        /**
+         * Array of sequential sum of values of metergroup items.
+         */
+        percentages?: number;
+    }): TemplateRef<any>;
+    /**
+     * Custom icon template.
+     */
+    icon(context: {
+        /**
+         * Current value of the component.
+         */
+        $implicit?: MeterItem;
+        /**
+         * Style class of the icon.
+         */
+        class?: string;
+    }): TemplateRef<any>;
+}
+/**
+ * Represents a meter item configuration.
+ * @group Interface
+ */
+interface MeterItem {
+    /**
+     * Label of the meter item.
+     */
+    label?: string;
+    /**
+     * Value of the meter item.
+     */
+    value?: number;
+    /**
+     * Color of the meter item.
+     */
+    color?: string;
+    /**
+     * Icon of the meter item.
+     */
+    icon?: string;
+}
+
+export type { MeterGroupPassThrough, MeterGroupPassThroughOptions, MeterGroupTemplates, MeterItem };