primeng 20.2.0 → 20.3.0-rc.1

package/types/card/index.d.ts

@@ -0,0 +1,75 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Card.pt}
+ * @group Interface
+ */
+interface CardPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the body's DOM element.
+     */
+    body?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the subtitle's DOM element.
+     */
+    subtitle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the title's DOM element.
+     */
+    title?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Card component.
+ * @see {@link CardPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type CardPassThrough<I = unknown> = PassThrough<I, CardPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Card.
+ * @group Templates
+ */
+interface CardTemplates {
+    /**
+     * Custom template of header.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom template of title.
+     */
+    title(): TemplateRef<any>;
+    /**
+     * Custom template of subtitle.
+     */
+    subtitle(): TemplateRef<any>;
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of footer.
+     */
+    footer(): TemplateRef<any>;
+}
+
+export type { CardPassThrough, CardPassThroughOptions, CardTemplates };

package/types/carousel/index.d.ts

@@ -0,0 +1,140 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThroughOptions } from 'primeng/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Carousel.pt}
+ * @group Interface
+ */
+interface CarouselPassThroughOptions<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 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 previous button's DOM element.
+     */
+    pcPrevButton?: ButtonPassThroughOptions;
+    /**
+     * Used to pass attributes to the viewport's DOM element.
+     */
+    viewport?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the item list's DOM element.
+     */
+    itemList?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the item clone's DOM element.
+     */
+    itemClone?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the next button's DOM element.
+     */
+    pcNextButton?: ButtonPassThroughOptions;
+    /**
+     * Used to pass attributes to the indicator list's DOM element.
+     */
+    indicatorList?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the indicator's DOM element.
+     */
+    indicator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the indicator button's DOM element.
+     */
+    indicatorButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Carousel.
+ * @see {@link CarouselPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type CarouselPassThrough<I = unknown> = PassThrough<I, CarouselPassThroughOptions<I>>;
+/**
+ * Responsive options of the component.
+ * @group Interface
+ */
+interface CarouselResponsiveOptions {
+    /**
+     * Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
+     */
+    breakpoint: string;
+    /**
+     * The number of visible items on breakpoint.
+     */
+    numVisible: number;
+    /**
+     * The number of scrolled items on breakpoint.
+     */
+    numScroll: number;
+}
+/**
+ * Custom page event.
+ * @group Events
+ */
+interface CarouselPageEvent {
+    /**
+     * Current page.
+     */
+    page?: number;
+}
+/**
+ * Defines valid templates in Carousel.
+ * @group Templates
+ */
+interface CarouselTemplates {
+    /**
+     * Custom template of header.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom template of item.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Data of the item.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of previousicon.
+     */
+    previousicon(): TemplateRef<any>;
+    /**
+     * Custom template of nexticon.
+     */
+    nexticon(): TemplateRef<any>;
+    /**
+     * Custom template of footer.
+     */
+    footer(): TemplateRef<any>;
+}
+
+export type { CarouselPageEvent, CarouselPassThrough, CarouselPassThroughOptions, CarouselResponsiveOptions, CarouselTemplates };

package/types/cascadeselect/index.d.ts

@@ -0,0 +1,198 @@
+import { ElementRef, TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link CascadeSelect.pt}
+ * @group Interface
+ */
+interface CascadeSelectPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hidden input wrapper's DOM element.
+     */
+    hiddenInputWrapper?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hidden input's DOM element.
+     */
+    hiddenInput?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement, 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 clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the overlay's DOM element.
+     */
+    overlay?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the list container's DOM element.
+     */
+    listContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the list's DOM element.
+     */
+    list?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the option list's DOM element.
+     */
+    optionList?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the option's DOM element.
+     */
+    option?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the option content's DOM element.
+     */
+    optionContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the option text's DOM element.
+     */
+    optionText?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the group icon's DOM element.
+     */
+    groupIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in CascadeSelect.
+ * @see {@link CascadeSelectPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type CascadeSelectPassThrough<I = unknown> = PassThrough<I, CascadeSelectPassThroughOptions<I>>;
+/**
+ * Custom panel show event.
+ * @see {@link CascadeSelect.onShow}
+ * @group Events
+ */
+interface CascadeSelectShowEvent {
+    /**
+     * Overlay element.
+     */
+    overlay?: ElementRef | TemplateRef<any> | HTMLElement | null | undefined;
+    /**
+     * Target element.
+     */
+    target?: ElementRef | TemplateRef<any> | HTMLElement | null | undefined;
+    /**
+     * Overlay mode.
+     */
+    overlayMode?: 'modal' | 'overlay' | string;
+}
+/**
+ * Custom panel hide event.
+ * @see {@link CascadeSelect.onHide}
+ * @extends {CascadeSelectShowEvent}
+ * @group Events
+ */
+interface CascadeSelectHideEvent extends CascadeSelectShowEvent {
+}
+/**
+ * Custom panel show event emits right before the panel is shown.
+ * @see {@link CascadeSelect.onBeforeShow}
+ * @extends {CascadeSelectShowEvent}
+ * @group Events
+ */
+interface CascadeSelectBeforeShowEvent extends CascadeSelectShowEvent {
+}
+/**
+ * Custom panel hide event emits right before the panel is hidden.
+ * @see {@link CascadeSelect.onBeforeHide}
+ * @extends {CascadeSelectShowEvent}
+ * @group Events
+ */
+interface CascadeSelectBeforeHideEvent extends CascadeSelectShowEvent {
+}
+/**
+ * Custom panel change event emits when selection changed.
+ * @see {@link CascadeSelect.onChange}
+ * @group Events
+ */
+interface CascadeSelectChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected value.
+     */
+    value?: any;
+    /**
+     * Focus state.
+     */
+    isFocus?: boolean;
+}
+/**
+ * Defines valid templates in CascadeSelect.
+ * @group Templates
+ */
+interface CascadeSelectTemplates {
+    /**
+     * Custom value template.
+     * @param {Object} context - value data.
+     */
+    value(context: {
+        /**
+         * Value.
+         */
+        $implicit: any;
+        /**
+         * Placeholder.
+         */
+        placeholder: string;
+    }): TemplateRef<{
+        $implicit: any;
+        placeholder: string;
+    }>;
+    /**
+     * Custom option template.
+     * @param {Object} context - option data.
+     */
+    option(context: {
+        /**
+         * Option instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    triggericon(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom option group icon template.
+     */
+    optiongroupicon(): TemplateRef<any>;
+    /**
+     * Custom loading icon template.
+     */
+    loadingicon(): TemplateRef<any>;
+}
+
+export type { CascadeSelectBeforeHideEvent, CascadeSelectBeforeShowEvent, CascadeSelectChangeEvent, CascadeSelectHideEvent, CascadeSelectPassThrough, CascadeSelectPassThroughOptions, CascadeSelectShowEvent, CascadeSelectTemplates };

package/types/chart/index.d.ts

@@ -0,0 +1,32 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link UIChart.pt}
+ * @group Interface
+ */
+interface ChartPassThroughOptions<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 canvas DOM element.
+     */
+    canvas?: PassThroughOption<HTMLCanvasElement, I>;
+}
+/**
+ * Defines valid pass-through options in Chart.
+ * @see {@link ChartPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ChartPassThrough<I = unknown> = PassThrough<I, ChartPassThroughOptions<I>>;
+
+export type { ChartPassThrough, ChartPassThroughOptions };

package/types/checkbox/index.d.ts

@@ -0,0 +1,62 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom change event.
+ * @see {@link Checkbox.onChange}
+ * @group Events
+ */
+interface CheckboxChangeEvent {
+    /**
+     * Checked value.
+     */
+    checked?: any;
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Defines valid templates in Checkbox.
+ * @group Templates
+ */
+interface CheckboxTemplates {
+    /**
+     * Custom checkbox icon template
+     */
+    icon(): TemplateRef<any>;
+}
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link CheckboxProps.pt}
+ * @group Interface
+ */
+interface CheckboxPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, 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<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Checkbox.
+ * @see {@link CheckboxPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type CheckboxPassThrough<I = unknown> = PassThrough<I, CheckboxPassThroughOptions<I>>;
+
+export type { CheckboxChangeEvent, CheckboxPassThrough, CheckboxPassThroughOptions, CheckboxTemplates };

package/types/chip/index.d.ts

@@ -0,0 +1,71 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Chip.pt}
+ * @group Interface
+ */
+interface ChipPassThroughOptions<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 image's DOM element.
+     */
+    image?: PassThroughOption<HTMLImageElement, 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<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the remove icon's DOM element.
+     */
+    removeIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Chip component.
+ * @see {@link ChipPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ChipPassThrough<I = unknown> = PassThrough<I, ChipPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Chip.
+ * @group Templates
+ */
+interface ChipTemplates {
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of remove icon.
+     */
+    removeicon(): TemplateRef<any>;
+}
+interface ChipProps {
+    label?: string;
+    icon?: string | undefined;
+    image?: string | undefined;
+    alt?: string | undefined;
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    styleClass?: string | undefined;
+    removable?: boolean | undefined;
+    removeIcon?: string | undefined;
+}
+
+export type { ChipPassThrough, ChipPassThroughOptions, ChipProps, ChipTemplates };

package/types/colorpicker/index.d.ts

@@ -0,0 +1,73 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ColorPicker.pt}
+ * @group Interface
+ */
+interface ColorPickerPassThroughOptions<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 preview input's DOM element.
+     */
+    preview?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the panel's DOM element.
+     */
+    panel?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the color selector's DOM element.
+     */
+    colorSelector?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the color background's DOM element.
+     */
+    colorBackground?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the color handle's DOM element.
+     */
+    colorHandle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hue's DOM element.
+     */
+    hue?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hue handle's DOM element.
+     */
+    hueHandle?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type ColorPickerPassThrough<I = unknown> = PassThrough<I, ColorPickerPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link ColorPicker.onChange}
+ * @group Events
+ */
+interface ColorPickerChangeEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Selected color value.
+     */
+    value: string | object;
+}
+
+export type { ColorPickerChangeEvent, ColorPickerPassThrough, ColorPickerPassThroughOptions };