primeng 20.1.2 → 20.3.0-rc.1

package/types/picklist/index.d.ts

@@ -0,0 +1,353 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+import { ListBoxPassThrough } from 'primeng/types/listbox';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link PickList.pt}
+ * @group Interface
+ */
+interface PickListPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the source controls' DOM element.
+     */
+    sourceControls?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the source list container's DOM element.
+     */
+    sourceListContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the transfer controls' DOM element.
+     */
+    transferControls?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the target list container's DOM element.
+     */
+    targetListContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the target controls' DOM element.
+     */
+    targetControls?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the source move up Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveUpButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the source move top Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveTopButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the source move down Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveDownButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the source move bottom Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveBottomButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move to target Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveToTargetButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move all to target Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveAllToTargetButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move to source Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveToSourceButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move all to source Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveAllToSourceButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move up Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveUpButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move top Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveTopButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move down Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveDownButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move bottom Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveBottomButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the Listbox component.
+     * @see {@link ListBoxPassThrough}
+     */
+    pcListbox?: ListBoxPassThrough;
+}
+/**
+ * Defines valid pass-through options in PickList.
+ * @see {@link PickListPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PickListPassThrough<I = unknown> = PassThrough<I, PickListPassThroughOptions<I>>;
+/**
+ * Callbacks to invoke on filter.
+ * @group Interface
+ */
+interface PickListFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom move to source event.
+ * @see {@link PickList.onMoveToSource}
+ * @group Events
+ */
+interface PickListMoveToSourceEvent {
+    /**
+     * Moved items.
+     */
+    items: any[];
+}
+/**
+ * Custom move all to source event.
+ * @see {@link PickList.onMoveAllToSource}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListMoveAllToSourceEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move all to target event.
+ * @see {@link PickList.onMoveAllToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListMoveAllToTargetEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move to target event.
+ * @see {@link PickList.onMoveToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListMoveToTargetEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move source reorder event.
+ * @see {@link PickList.onSourceReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListSourceReorderEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move target reorder event.
+ * @see {@link PickList.onTargetReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListTargetReorderEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom source select event.
+ * @see {@link PickList.onSourceSelect}
+ * @group Events
+ */
+interface PickListSourceSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected items.
+     */
+    items: any[];
+}
+/**
+ * Custom target select event.
+ * @see {@link PickList.onTargetSelect}
+ * @extends {PickListSourceSelectEvent}
+ * @group Events
+ */
+interface PickListTargetSelectEvent extends PickListSourceSelectEvent {
+}
+/**
+ * Custom source filter event.
+ * @see {@link PickList.onSourceFilter}
+ * @group Events
+ */
+interface PickListSourceFilterEvent {
+    /**
+     * Filter value.
+     */
+    query: string | null | undefined;
+    /**
+     * Filtered items.
+     */
+    value: any[] | null | undefined;
+}
+/**
+ * Custom target filter event.
+ * @see {@link PickList.onTargetFilter}
+ * @extends {PickListSourceFilterEvent}
+ * @group Events
+ */
+interface PickListTargetFilterEvent extends PickListSourceFilterEvent {
+}
+/**
+ * Defines valid templates in PickList.
+ * @group Templates
+ */
+interface PickListTemplates {
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+        /**
+         * Item index.
+         */
+        index: number;
+    }): TemplateRef<{
+        $implicit: any;
+        index: number;
+    }>;
+    /**
+     * Custom source header template.
+     */
+    sourceHeader(): TemplateRef<any>;
+    /**
+     * Custom target header template.
+     */
+    targetHeader(): TemplateRef<any>;
+    /**
+     * Custom source filter template.
+     */
+    sourceFilter(context: {
+        /**
+         * Source filter options.
+         */
+        options: PickListFilterOptions;
+    }): TemplateRef<{
+        options: PickListFilterOptions;
+    }>;
+    /**
+     * Custom target filter template.
+     */
+    targetFilter(context: {
+        /**
+         * Target filter options.
+         */
+        options: PickListFilterOptions;
+    }): TemplateRef<{
+        options: PickListFilterOptions;
+    }>;
+    /**
+     * Custom source list empty message template.
+     */
+    emptymessagesource(): TemplateRef<any>;
+    /**
+     * Custom source list empty filter message template.
+     */
+    emptyfiltermessagesource(): TemplateRef<any>;
+    /**
+     * Custom target list empty message template.
+     */
+    emptymessagetarget(): TemplateRef<any>;
+    /**
+     * Custom target list empty filter message template.
+     */
+    emptyfiltermessagetarget(): TemplateRef<any>;
+    /**
+     * Custom move up icon template.
+     */
+    moveupicon(): TemplateRef<any>;
+    /**
+     * Custom move top icon template.
+     */
+    movetopicon(): TemplateRef<any>;
+    /**
+     * Custom move down icon template.
+     */
+    movedownicon(): TemplateRef<any>;
+    /**
+     * Custom move bottom icon template.
+     */
+    movebottomicon(): TemplateRef<any>;
+    /**
+     * Custom move to target icon template.
+     */
+    movetotargeticon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom move all to target icon template.
+     */
+    movealltotargeticon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom move to source icon template.
+     */
+    movetosourceicon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom move all to source icon template.
+     */
+    movealltosourceicon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom target filter icon template.
+     */
+    targetfiltericon(): TemplateRef<any>;
+    /**
+     * Custom source filter icon template.
+     */
+    sourcefiltericon(): TemplateRef<any>;
+}
+
+export type { PickListFilterOptions, PickListMoveAllToSourceEvent, PickListMoveAllToTargetEvent, PickListMoveToSourceEvent, PickListMoveToTargetEvent, PickListPassThrough, PickListPassThroughOptions, PickListSourceFilterEvent, PickListSourceReorderEvent, PickListSourceSelectEvent, PickListTargetFilterEvent, PickListTargetReorderEvent, PickListTargetSelectEvent, PickListTemplates };

package/types/popover/index.d.ts

@@ -0,0 +1,52 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Popover.pt}
+ * @group Interface
+ */
+interface PopoverPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in Popover.
+ * @see {@link PopoverPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PopoverPassThrough<I = unknown> = PassThrough<I, PopoverPassThroughOptions<I>>;
+/**
+ * Defines valid templates in OverlayPanel.
+ * @group Templates
+ */
+interface PopoverTemplates {
+    /**
+     * Custom template of content.
+     * @param {Object} context - closeCallback.
+     */
+    content(context: {
+        closeCallback: VoidFunction;
+    }): TemplateRef<{
+        closeCallback: VoidFunction;
+    }>;
+    /**
+     * Custom template of closeicon.
+     */
+    closeicon(): TemplateRef<any>;
+}
+
+export type { PopoverPassThrough, PopoverPassThroughOptions, PopoverTemplates };

package/types/progressbar/index.d.ts

@@ -0,0 +1,54 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ProgressBar.pt}
+ * @group Interface
+ */
+interface ProgressBarPassThroughOptions<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 value's DOM element.
+     */
+    value?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in ProgressBar.
+ * @see {@link ProgressBarPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ProgressBarPassThrough<I = unknown> = PassThrough<I, ProgressBarPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ProgressBar.
+ * @group Templates
+ */
+interface ProgressBarTemplates {
+    /**
+     * Custom template of content.
+     */
+    content(context: {
+        /**
+         * Value of the progressbar.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: number | undefined;
+    }>;
+}
+
+export type { ProgressBarPassThrough, ProgressBarPassThroughOptions, ProgressBarTemplates };

package/types/progressspinner/index.d.ts

@@ -0,0 +1,36 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ProgressSpinner.pt}
+ * @group Interface
+ */
+interface ProgressSpinnerPassThroughOptions<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<SVGSVGElement, I>;
+    /**
+     * Used to pass attributes to the spin's DOM element.
+     */
+    spin?: PassThroughOption<SVGSVGElement, I>;
+    /**
+     * Used to pass attributes to the circle's DOM element.
+     */
+    circle?: PassThroughOption<SVGCircleElement, I>;
+}
+/**
+ * Defines valid pass-through options in ProgressSpinner.
+ * @see {@link ProgressSpinnerPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ProgressSpinnerPassThrough<I = unknown> = PassThrough<I, ProgressSpinnerPassThroughOptions<I>>;
+
+export type { ProgressSpinnerPassThrough, ProgressSpinnerPassThroughOptions };

package/types/radiobutton/index.d.ts

@@ -0,0 +1,51 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom passthrough(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link RadioButton.pt}
+ * @group Interface
+ */
+interface RadioButtonPassThroughOptions<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 box's DOM element.
+     */
+    box?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in RadioButton component.
+ * @see {@link RadioButtonPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type RadioButtonPassThrough<I = unknown> = PassThrough<I, RadioButtonPassThroughOptions<I>>;
+/**
+ * Custom click event.
+ * @see {@link RadioButton.onClick}
+ * @group Events
+ */
+interface RadioButtonClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Browser event.
+     */
+    value: any;
+}
+
+export type { RadioButtonClickEvent, RadioButtonPassThrough, RadioButtonPassThroughOptions };

package/types/rating/index.d.ts

@@ -0,0 +1,82 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { TemplateRef } from '@angular/core';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Rating.pt}
+ * @group Interface
+ */
+interface RatingPassThroughOptions<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 option's DOM element.
+     */
+    option?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the on icon's DOM element.
+     */
+    onIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the off icon's DOM element.
+     */
+    offIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the hidden option input container's DOM element.
+     */
+    hiddenOptionInputContainer?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden option input's DOM element.
+     */
+    hiddenOptionInput?: PassThroughOption<HTMLInputElement, I>;
+}
+/**
+ * Defines valid pass-through options in Rating component.
+ * @see {@link RatingPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type RatingPassThrough<I = unknown> = PassThrough<I, RatingPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link Rating.onRate}
+ * @group Events
+ */
+interface RatingRateEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value
+     */
+    value: number;
+}
+/**
+ * Defines valid templates in Rating.
+ * @group Templates
+ */
+interface RatingTemplates {
+    /**
+     * Custom on icon template.
+     */
+    onicon(): TemplateRef<any>;
+    /**
+     * Custom off icon template.
+     */
+    officon(): TemplateRef<any>;
+    /**
+     * Custom cancel icon template.
+     */
+    cancelicon(): TemplateRef<any>;
+}
+
+export type { RatingPassThrough, RatingPassThroughOptions, RatingRateEvent, RatingTemplates };