primenglab 22.0.0-beta.1

package/types/primenglab-types-slider.d.ts

@@ -0,0 +1,91 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Defines the orientation of the slider.
+ * @group Types
+ */
+type SliderOrientation = 'horizontal' | 'vertical';
+/**
+ * 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 track's DOM element.
+     */
+    track?: 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>;
+    /**
+     * Used to pass attributes to the hidden input's DOM element.
+     */
+    input?: PassThroughOption<HTMLInputElement, 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, SliderOrientation, SliderPassThrough, SliderPassThroughOptions, SliderSlideEndEvent };

package/types/primenglab-types-speeddial.d.ts

@@ -0,0 +1,110 @@
+import { TemplateRef } from '@angular/core';
+import { MenuItem, PassThrough, PassThroughOption } from 'primenglab/api';
+import { ButtonPassThrough } from 'primenglab/types/button';
+
+/**
+ * Defines the direction of the SpeedDial.
+ * @group Types
+ */
+type SpeedDialDirection = 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right';
+/**
+ * Defines the type of the SpeedDial.
+ * @group Types
+ */
+type SpeedDialType = 'linear' | 'circle' | 'semi-circle' | 'quarter-circle';
+/**
+ * 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>>;
+/**
+ * Custom button template context.
+ * @group Interface
+ */
+interface SpeedDialButtonTemplateContext {
+    /**
+     * Callback to toggle the speed dial visibility.
+     */
+    toggleCallback: (event: MouseEvent) => void;
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface SpeedDialItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+    /**
+     * Index of the item.
+     */
+    index: number;
+    /**
+     * Callback to handle item click.
+     */
+    toggleCallback: (event: Event, item: MenuItem) => void;
+}
+/**
+ * Defines valid templates in SpeedDial.
+ * @group Templates
+ */
+interface SpeedDialTemplates {
+    /**
+     * Custom button template.
+     * @param {SpeedDialButtonTemplateContext} context - button context.
+     */
+    button(context: SpeedDialButtonTemplateContext): TemplateRef<SpeedDialButtonTemplateContext>;
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<void>;
+    /**
+     * Custom item template.
+     * @param {SpeedDialItemTemplateContext} context - item context.
+     */
+    item(context: SpeedDialItemTemplateContext): TemplateRef<SpeedDialItemTemplateContext>;
+}
+
+export type { SpeedDialButtonTemplateContext, SpeedDialDirection, SpeedDialItemTemplateContext, SpeedDialPassThrough, SpeedDialPassThroughOptions, SpeedDialTemplates, SpeedDialType };

package/types/primenglab-types-splitbutton.d.ts

@@ -0,0 +1,60 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { ButtonPassThrough } from 'primenglab/types/button';
+import { MenuPassThrough } from 'primenglab/types/menu';
+
+/**
+ * Defines the icon position of the SplitButton.
+ * @group Types
+ */
+type SplitButtonIconPosition = 'left' | 'right';
+/**
+ * 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 content template.
+     */
+    content(): TemplateRef<void>;
+    /**
+     * Custom dropdown icon template.
+     */
+    dropdownicon(): TemplateRef<void>;
+}
+
+export type { SplitButtonIconPosition, SplitButtonPassThrough, SplitButtonPassThroughOptions, SplitButtonTemplates };

package/types/primenglab-types-splitter.d.ts

@@ -0,0 +1,127 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Defines the layout orientation for Splitter component.
+ * @group Types
+ */
+type SplitterLayout = 'horizontal' | 'vertical';
+/**
+ * Defines the state storage type for Splitter component.
+ * @group Types
+ */
+type SplitterStateStorage = 'session' | 'local';
+/**
+ * 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 pass-through(pt) options for SplitterPanel.
+ * @template I Type of instance.
+ *
+ * @see {@link SplitterPanel.pt}
+ * @group Interface
+ */
+interface SplitterPanelPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in SplitterPanel component.
+ * @see {@link SplitterPanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SplitterPanelPassThrough<I = unknown> = PassThrough<I, SplitterPanelPassThroughOptions<I>>;
+/**
+ * Custom panel resize start event.
+ * @see {@link Splitter.onResizeStart}
+ * @group Events
+ */
+interface SplitterResizeStartEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: PointerEvent | KeyboardEvent;
+    /**
+     * Sizes of the panels, can be percentages, pixels, rem, or other CSS units.
+     */
+    sizes: (number | string)[];
+}
+/**
+ * Custom panel resize event, invoked continuously while a gutter is being dragged.
+ * @see {@link Splitter.onResize}
+ * @extends {SplitterResizeStartEvent}
+ * @group Events
+ */
+interface SplitterResizeEvent extends SplitterResizeStartEvent {
+}
+/**
+ * Custom panel resize end event.
+ * @see {@link Splitter.onResizeEnd}
+ * @extends {SplitterResizeStartEvent}
+ * @group Events
+ */
+interface SplitterResizeEndEvent extends SplitterResizeStartEvent {
+}
+/**
+ * Custom collapse event, invoked when a collapsible panel collapses or expands.
+ * @see {@link Splitter.onCollapse}
+ * @group Events
+ */
+interface SplitterCollapseEvent {
+    /**
+     * Index of the panel whose collapsed state changed.
+     */
+    index: number;
+    /**
+     * Current collapsed state of the panel.
+     */
+    collapsed: boolean;
+    /**
+     * Sizes of the panels at the moment the change happened.
+     */
+    sizes: number[];
+}
+/**
+ * Defines valid templates in Splitter.
+ * @group Templates
+ */
+interface SplitterTemplates {
+    /**
+     * Custom panel template.
+     */
+    panel(): TemplateRef<void>;
+}
+
+export type { SplitterCollapseEvent, SplitterLayout, SplitterPanelPassThrough, SplitterPanelPassThroughOptions, SplitterPassThrough, SplitterPassThroughOptions, SplitterResizeEndEvent, SplitterResizeEvent, SplitterResizeStartEvent, SplitterStateStorage, SplitterTemplates };

package/types/primenglab-types-stepper.d.ts

@@ -0,0 +1,186 @@
+import { MotionOptions } from '@primeuix/motion';
+import { PassThrough, PassThroughOption } from 'primenglab/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>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * 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 wrapper DOM element.
+     */
+    contentWrapper?: PassThroughOption<HTMLDivElement, 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>>;
+/**
+ * Context interface for the StepPanel content template.
+ * @property {() => void} activateCallback - Callback function to activate a step.
+ * @property {number} value - The value associated with the step.
+ * @property {boolean} active - A flag indicating whether the step is active.
+ * @group Interface
+ */
+interface StepContentTemplateContext {
+    activateCallback: () => void;
+    value: number | undefined;
+    active: boolean;
+}
+/**
+ * Context interface for the StepPanel content template.
+ * @property {(index: number) => void} activateCallback - Callback function to activate a step.
+ * @property {number} value - The value associated with the step.
+ * @property {boolean} active - A flag indicating whether the step is active.
+ * @group Interface
+ */
+interface StepPanelContentTemplateContext {
+    activateCallback: (index: number) => void;
+    value: number | undefined;
+    active: boolean;
+}
+
+export type { StepContentTemplateContext, StepItemPassThrough, StepItemPassThroughOptions, StepListPassThrough, StepListPassThroughOptions, StepPanelContentTemplateContext, StepPanelPassThrough, StepPanelPassThroughOptions, StepPanelsPassThrough, StepPanelsPassThroughOptions, StepPassThrough, StepPassThroughOptions, StepperPassThrough, StepperPassThroughOptions, StepperSeparatorPassThrough, StepperSeparatorPassThroughOptions };