primeng 20.1.2 → 20.3.0-rc.1

package/types/slider/index.d.ts

@@ -0,0 +1,78 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom passthrough(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Slider.pt}
+ * @group Interface
+ */
+interface SliderPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the range's DOM element.
+     */
+    range?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the handle's DOM element.
+     */
+    handle?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the start handler's DOM element.
+     */
+    startHandler?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the end handler's DOM element.
+     */
+    endHandler?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in Slider component.
+ * @see {@link SliderPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SliderPassThrough<I = unknown> = PassThrough<I, SliderPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link Slider.onChange}
+ * @group Events
+ */
+interface SliderChangeEvent {
+    /**
+     * Browser event.
+     */
+    event: Event;
+    /**
+     * New values.
+     */
+    values?: number[];
+    /**
+     * New value.
+     */
+    value?: number;
+}
+/**
+ * Custom slide end event.
+ * @see {@link Slider.onSlideEnd}
+ * @group Events
+ */
+interface SliderSlideEndEvent {
+    /**
+     * Original event
+     */
+    originalEvent: Event;
+    /**
+     * New value.
+     */
+    value?: number;
+    /**
+     * New values.
+     */
+    values?: number[];
+}
+
+export type { SliderChangeEvent, SliderPassThrough, SliderPassThroughOptions, SliderSlideEndEvent };

package/types/speeddial/index.d.ts

@@ -0,0 +1,82 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link SpeedDial.pt}
+ * @group Interface
+ */
+interface SpeedDialPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the list's DOM element.
+     */
+    list?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the action's Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAction?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the action icon's DOM element.
+     */
+    actionIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in SpeedDial component.
+ * @see {@link SpeedDialPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SpeedDialPassThrough<I = unknown> = PassThrough<I, SpeedDialPassThroughOptions<I>>;
+/**
+ * Defines valid templates in SpeedDial.
+ * @group Templates
+ */
+interface SpeedDialTemplates {
+    /**
+     * Custom button template.
+     */
+    button(context: {
+        toggleCallback: (event: Event) => void;
+    }): TemplateRef<any>;
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<any>;
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        item: any;
+        index: number;
+        toggleCallback: (event: Event, item: any) => void;
+    }): TemplateRef<any>;
+    /**
+     * Custom item icon template.
+     */
+    itemicon(context: {
+        item: any;
+    }): TemplateRef<any>;
+}
+
+export type { SpeedDialPassThrough, SpeedDialPassThroughOptions, SpeedDialTemplates };

package/types/splitbutton/index.d.ts

@@ -0,0 +1,70 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+import { MenuPassThrough } from 'primeng/types/menu';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link SplitButton.pt}
+ * @group Interface
+ */
+interface SplitButtonPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the dropdown Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcDropdown?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the TieredMenu component.
+     */
+    pcMenu?: MenuPassThrough;
+}
+/**
+ * Defines valid pass-through options in SplitButton component.
+ * @see {@link SplitButtonPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SplitButtonPassThrough<I = unknown> = PassThrough<I, SplitButtonPassThroughOptions<I>>;
+/**
+ * Defines valid templates in SplitButton.
+ * @group Templates
+ */
+interface SplitButtonTemplates {
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of dropdownicon.
+     */
+    dropdownicon(): TemplateRef<any>;
+}
+/**
+ * Defines ButtonProps interface.
+ */
+interface ButtonProps {
+    ariaLabel?: string;
+}
+/**
+ * Defines MenuButtonProps interface.
+ */
+interface MenuButtonProps {
+    ariaLabel?: string;
+    ariaHasPopup?: boolean;
+    ariaExpanded?: boolean;
+    ariaControls?: string;
+}
+
+export type { ButtonProps, MenuButtonProps, SplitButtonPassThrough, SplitButtonPassThroughOptions, SplitButtonTemplates };

package/types/splitter/index.d.ts

@@ -0,0 +1,70 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Splitter.pt}
+ * @group Interface
+ */
+interface SplitterPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the panel's DOM element.
+     */
+    panel: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the gutter's DOM element.
+     */
+    gutter?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the gutter handle's DOM element.
+     */
+    gutterHandle?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Splitter component.
+ * @see {@link SplitterPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SplitterPassThrough<I = unknown> = PassThrough<I, SplitterPassThroughOptions<I>>;
+/**
+ * Custom panel resize start event.
+ * @see {@link Splitter.onResizeStart}
+ * @group Events
+ */
+interface SplitterResizeStartEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: TouchEvent | MouseEvent;
+    /**
+     * Sizes of the panels, can be percentages, pixels, rem, or other CSS units.
+     */
+    sizes: (number | string)[];
+}
+/**
+ * Custom panel resize end event.
+ * @see {@link Splitter.onResizeEnd}
+ * @extends {SplitterResizeStartEvent}
+ * @group Events
+ */
+interface SplitterResizeEndEvent extends SplitterResizeStartEvent {
+}
+/**
+ * Defines valid templates in Panel.
+ * @group Templates
+ */
+interface SplitterTemplates {
+    /**
+     * Custom panel template.
+     */
+    panel(): TemplateRef<any>;
+}
+
+export type { SplitterPassThrough, SplitterPassThroughOptions, SplitterResizeEndEvent, SplitterResizeStartEvent, SplitterTemplates };

package/types/stepper/index.d.ts

@@ -0,0 +1,153 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Defines valid pass-through options in Stepper component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface StepperPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Stepper component.
+ * @see {@link StepperPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type StepperPassThrough<I = unknown> = PassThrough<I, StepperPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in StepList component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface StepListPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in StepList component.
+ * @see {@link StepListPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type StepListPassThrough<I = unknown> = PassThrough<I, StepListPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in StepperSeparator component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface StepperSeparatorPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the separator's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in StepperSeparator component.
+ * @see {@link StepperSeparatorPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type StepperSeparatorPassThrough<I = unknown> = PassThrough<I, StepperSeparatorPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in StepItem component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface StepItemPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in StepItem component.
+ * @see {@link StepItemPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type StepItemPassThrough<I = unknown> = PassThrough<I, StepItemPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in Step component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface StepPassThroughOptions<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<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the number's DOM element.
+     */
+    number?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the title's DOM element.
+     */
+    title?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in Step component.
+ * @see {@link StepPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type StepPassThrough<I = unknown> = PassThrough<I, StepPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in StepPanel component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface StepPanelPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in StepPanel component.
+ * @see {@link StepPanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type StepPanelPassThrough<I = unknown> = PassThrough<I, StepPanelPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in StepPanels component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface StepPanelsPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in StepPanels component.
+ * @see {@link StepPanelsPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type StepPanelsPassThrough<I = unknown> = PassThrough<I, StepPanelsPassThroughOptions<I>>;
+
+export type { StepItemPassThrough, StepItemPassThroughOptions, StepListPassThrough, StepListPassThroughOptions, StepPanelPassThrough, StepPanelPassThroughOptions, StepPanelsPassThrough, StepPanelsPassThroughOptions, StepPassThrough, StepPassThroughOptions, StepperPassThrough, StepperPassThroughOptions, StepperSeparatorPassThrough, StepperSeparatorPassThroughOptions };