primenglab 22.0.0-beta.1

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

@@ -0,0 +1,27 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+type IconFieldIconPosition = 'right' | 'left';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link IconField.pt}
+ * @group Interface
+ */
+interface IconFieldPassThroughOptions<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<HTMLSpanElement, I>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type IconFieldPassThrough<I = unknown> = PassThrough<I, IconFieldPassThroughOptions<I>>;
+
+export type { IconFieldIconPosition, IconFieldPassThrough, IconFieldPassThroughOptions };

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

@@ -0,0 +1,26 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link IftaLabel.pt}
+ * @group Interface
+ */
+interface IftaLabelPassThroughOptions<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<HTMLSpanElement, I>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type IftaLabelPassThrough<I = unknown> = PassThrough<I, IftaLabelPassThroughOptions<I>>;
+
+export type { IftaLabelPassThrough, IftaLabelPassThroughOptions };

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

@@ -0,0 +1,149 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+type ImageLoading = 'lazy' | 'eager';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Image.pt}
+ * @group Interface
+ */
+interface ImagePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the image's DOM element.
+     */
+    image?: PassThroughOption<HTMLImageElement, I>;
+    /**
+     * Used to pass attributes to the preview mask button's DOM element.
+     */
+    previewMask?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the preview icon's DOM element.
+     */
+    previewIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the toolbar's DOM element.
+     */
+    toolbar?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the rotate right button's DOM element.
+     */
+    rotateRightButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the rotate left button's DOM element.
+     */
+    rotateLeftButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the zoom out button's DOM element.
+     */
+    zoomOutButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the zoom in button's DOM element.
+     */
+    zoomInButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the close button's DOM element.
+     */
+    closeButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the original/preview image's DOM element.
+     */
+    original?: PassThroughOption<HTMLImageElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+    /**
+     * Used to pass motion options for the mask animation.
+     */
+    maskMotion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in Image.
+ * @see {@link ImagePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ImagePassThrough<I = unknown> = PassThrough<I, ImagePassThroughOptions<I>>;
+/**
+ * Custom image template context.
+ * @group Interface
+ */
+interface ImageImageTemplateContext {
+    /**
+     * Callback to invoke on image error.
+     */
+    errorCallback: (event: Event) => void;
+}
+/**
+ * Custom preview template context.
+ * @group Interface
+ */
+interface ImagePreviewTemplateContext {
+    /**
+     * Style class of the preview image element.
+     */
+    class: string;
+    /**
+     * Inline style of the preview image element.
+     */
+    style: {
+        [key: string]: any;
+    };
+    /**
+     * Callback to invoke on preview image click.
+     */
+    previewCallback: () => void;
+}
+/**
+ * Defines valid templates in Image.
+ * @group Templates
+ */
+interface ImageTemplates {
+    /**
+     * Custom indicator template.
+     */
+    indicator(): TemplateRef<void>;
+    /**
+     * Custom image template.
+     * @param {Object} context - image context.
+     */
+    image(context: ImageImageTemplateContext): TemplateRef<ImageImageTemplateContext>;
+    /**
+     * Custom preview template.
+     * @param {Object} context - preview context.
+     */
+    preview(context: ImagePreviewTemplateContext): TemplateRef<ImagePreviewTemplateContext>;
+    /**
+     * Custom rotate right icon template.
+     */
+    rotaterighticon(): TemplateRef<void>;
+    /**
+     * Custom rotate left icon template.
+     */
+    rotatelefticon(): TemplateRef<void>;
+    /**
+     * Custom zoom out icon template.
+     */
+    zoomouticon(): TemplateRef<void>;
+    /**
+     * Custom zoom in icon template.
+     */
+    zoominicon(): TemplateRef<void>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<void>;
+}
+
+export type { ImageImageTemplateContext, ImageLoading, ImagePassThrough, ImagePassThroughOptions, ImagePreviewTemplateContext, ImageTemplates };

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

@@ -0,0 +1,43 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ImageCompare.pt}
+ * @group Interface
+ */
+interface ImageComparePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the slider's DOM element.
+     */
+    slider?: PassThroughOption<HTMLInputElement, I>;
+}
+/**
+ * Defines valid pass-through options in ImageCompare.
+ * @see {@link ImageComparePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ImageComparePassThrough<I = unknown> = PassThrough<I, ImageComparePassThroughOptions<I>>;
+/**
+ * Defines valid templates in ImageCompare.
+ * @group Templates
+ */
+interface ImageCompareTemplates {
+    /**
+     * Custom left side template.
+     */
+    left(): TemplateRef<void>;
+    /**
+     * Custom right side template.
+     */
+    right(): TemplateRef<void>;
+}
+
+export type { ImageComparePassThrough, ImageComparePassThroughOptions, ImageCompareTemplates };

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

@@ -0,0 +1,72 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { ButtonPassThrough } from 'primenglab/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Inplace.pt}
+ * @group Interface
+ */
+interface InplacePassThroughOptions<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 display's DOM element.
+     */
+    display?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcButton?: ButtonPassThrough;
+}
+/**
+ * Defines valid pass-through options in Inplace.
+ * @see {@link InplacePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InplacePassThrough<I = unknown> = PassThrough<I, InplacePassThroughOptions<I>>;
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface InplaceContentTemplateContext {
+    /**
+     * Callback to invoke to close the inplace content.
+     */
+    closeCallback: (event: MouseEvent) => void;
+}
+/**
+ * Defines valid templates in Inplace.
+ * @group Templates
+ */
+interface InplaceTemplates {
+    /**
+     * Custom display template.
+     */
+    display(): TemplateRef<void>;
+    /**
+     * Custom content template.
+     * @param {Object} context - content context.
+     */
+    content(context: InplaceContentTemplateContext): TemplateRef<InplaceContentTemplateContext>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<void>;
+}
+
+export type { InplaceContentTemplateContext, InplacePassThrough, InplacePassThroughOptions, InplaceTemplates };

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

@@ -0,0 +1,206 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { ButtonPassThrough } from 'primenglab/types/button';
+
+/**
+ * Defines valid pass-through options in InputColor component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in InputColor component.
+ * @see {@link InputColorPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InputColorPassThrough<I = unknown> = PassThrough<I, InputColorPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorArea component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorAreaPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorArea component.
+ */
+type InputColorAreaPassThrough<I = unknown> = PassThrough<I, InputColorAreaPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorSlider component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorSliderPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorSlider component.
+ */
+type InputColorSliderPassThrough<I = unknown> = PassThrough<I, InputColorSliderPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorAreaBackground component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorAreaBackgroundPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorAreaBackground component.
+ */
+type InputColorAreaBackgroundPassThrough<I = unknown> = PassThrough<I, InputColorAreaBackgroundPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorAreaHandle component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorAreaHandlePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorAreaHandle component.
+ */
+type InputColorAreaHandlePassThrough<I = unknown> = PassThrough<I, InputColorAreaHandlePassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorSliderTrack component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorSliderTrackPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorSliderTrack component.
+ */
+type InputColorSliderTrackPassThrough<I = unknown> = PassThrough<I, InputColorSliderTrackPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorSliderHandle component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorSliderHandlePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorSliderHandle component.
+ */
+type InputColorSliderHandlePassThrough<I = unknown> = PassThrough<I, InputColorSliderHandlePassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorSwatch component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorSwatchPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorSwatch component.
+ */
+type InputColorSwatchPassThrough<I = unknown> = PassThrough<I, InputColorSwatchPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorSwatchBackground component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorSwatchBackgroundPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorSwatchBackground component.
+ */
+type InputColorSwatchBackgroundPassThrough<I = unknown> = PassThrough<I, InputColorSwatchBackgroundPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorTransparencyGrid component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorTransparencyGridPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputColorTransparencyGrid component.
+ */
+type InputColorTransparencyGridPassThrough<I = unknown> = PassThrough<I, InputColorTransparencyGridPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in InputColorEyeDropper component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface InputColorEyeDropperPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Button component.
+     */
+    pcButton?: ButtonPassThrough;
+}
+/**
+ * Defines valid pass-through options in InputColorEyeDropper component.
+ */
+type InputColorEyeDropperPassThrough<I = unknown> = PassThrough<I, InputColorEyeDropperPassThroughOptions<I>>;
+/**
+ * Custom value change event.
+ * @group Interface
+ */
+interface InputColorValueChangeEvent {
+    /**
+     * The color instance.
+     */
+    color: any;
+    /**
+     * Browser native event.
+     */
+    originalEvent?: Event;
+}
+
+export type { InputColorAreaBackgroundPassThrough, InputColorAreaBackgroundPassThroughOptions, InputColorAreaHandlePassThrough, InputColorAreaHandlePassThroughOptions, InputColorAreaPassThrough, InputColorAreaPassThroughOptions, InputColorEyeDropperPassThrough, InputColorEyeDropperPassThroughOptions, InputColorPassThrough, InputColorPassThroughOptions, InputColorSliderHandlePassThrough, InputColorSliderHandlePassThroughOptions, InputColorSliderPassThrough, InputColorSliderPassThroughOptions, InputColorSliderTrackPassThrough, InputColorSliderTrackPassThroughOptions, InputColorSwatchBackgroundPassThrough, InputColorSwatchBackgroundPassThroughOptions, InputColorSwatchPassThrough, InputColorSwatchPassThroughOptions, InputColorTransparencyGridPassThrough, InputColorTransparencyGridPassThroughOptions, InputColorValueChangeEvent };

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

@@ -0,0 +1,28 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputGroup.pt}
+ * @group Interface
+ */
+interface InputGroupPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in InputGroup.
+ * @see {@link InputGroupPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InputGroupPassThrough<I = unknown> = PassThrough<I, InputGroupPassThroughOptions<I>>;
+
+export type { InputGroupPassThrough, InputGroupPassThroughOptions };

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

@@ -0,0 +1,28 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputGroupAddon.pt}
+ * @group Interface
+ */
+interface InputGroupAddonPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in InputGroupAddon.
+ * @see {@link InputGroupAddonPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InputGroupAddonPassThrough<I = unknown> = PassThrough<I, InputGroupAddonPassThroughOptions<I>>;
+
+export type { InputGroupAddonPassThrough, InputGroupAddonPassThroughOptions };

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

@@ -0,0 +1,26 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputIcon.pt}
+ * @group Interface
+ */
+interface InputIconPassThroughOptions<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<HTMLSpanElement, I>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type InputIconPassThrough<I = unknown> = PassThrough<I, InputIconPassThroughOptions<I>>;
+
+export type { InputIconPassThrough, InputIconPassThroughOptions };

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

@@ -0,0 +1,56 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { InputTextPassThrough } from 'primenglab/types/inputtext';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputMask.pt}
+ * @group Interface
+ */
+interface InputMaskPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the InputText component.
+     */
+    pcInputText?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in InputMask.
+ * @see {@link InputMaskPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InputMaskPassThrough<I = unknown> = PassThrough<I, InputMaskPassThroughOptions<I>>;
+/**
+ * Caret positions.
+ * @group Types
+ */
+type Caret = {
+    begin: number;
+    end: number;
+};
+/**
+ * Defines valid templates in InputMask.
+ * @group Templates
+ */
+interface InputMaskTemplates {
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<void>;
+}
+
+export type { Caret, InputMaskPassThrough, InputMaskPassThroughOptions, InputMaskTemplates };