primenglab 22.0.0-beta.1

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

@@ -0,0 +1,59 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { PassThrough, PassThroughOption } from 'primenglab/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>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in Popover.
+ * @see {@link PopoverPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PopoverPassThrough<I = unknown> = PassThrough<I, PopoverPassThroughOptions<I>>;
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface PopoverContentTemplateContext {
+    /**
+     * Callback to close the popover.
+     */
+    closeCallback: VoidFunction;
+}
+/**
+ * Defines valid templates in Popover.
+ * @group Templates
+ */
+interface PopoverTemplates {
+    /**
+     * Custom template of content.
+     * @param {PopoverContentTemplateContext} context - content context.
+     */
+    content(context: PopoverContentTemplateContext): TemplateRef<PopoverContentTemplateContext>;
+}
+
+export type { PopoverContentTemplateContext, PopoverPassThrough, PopoverPassThroughOptions, PopoverTemplates };

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

@@ -0,0 +1,63 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Defines the mode of the progress bar.
+ * @group Types
+ */
+type ProgressBarMode = 'determinate' | 'indeterminate';
+/**
+ * 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>>;
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface ProgressBarContentTemplateContext {
+    /**
+     * Value of the progressbar.
+     */
+    $implicit: number | undefined;
+}
+/**
+ * Defines valid templates in ProgressBar.
+ * @group Templates
+ */
+interface ProgressBarTemplates {
+    /**
+     * Custom template of content.
+     * @param {ProgressBarContentTemplateContext} context - content context.
+     */
+    content(context: ProgressBarContentTemplateContext): TemplateRef<ProgressBarContentTemplateContext>;
+}
+
+export type { ProgressBarContentTemplateContext, ProgressBarMode, ProgressBarPassThrough, ProgressBarPassThroughOptions, ProgressBarTemplates };

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

@@ -0,0 +1,44 @@
+import { PassThrough, PassThroughOption } from 'primenglab/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<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the circle SVG element.
+     */
+    circle?: PassThroughOption<SVGSVGElement, I>;
+    /**
+     * Used to pass attributes to the circle track element.
+     */
+    circleTrack?: PassThroughOption<SVGCircleElement, I>;
+    /**
+     * Used to pass attributes to the circle range element.
+     */
+    circleRange?: PassThroughOption<SVGCircleElement, I>;
+    /**
+     * Used to pass attributes to the value text element.
+     */
+    value?: PassThroughOption<SVGTextElement, 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/primenglab-types-radiobutton.d.ts

@@ -0,0 +1,51 @@
+import { PassThrough, PassThroughOption } from 'primenglab/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/primenglab-types-rating.d.ts

@@ -0,0 +1,94 @@
+import { PassThrough, PassThroughOption } from 'primenglab/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;
+}
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface RatingIconTemplateContext {
+    /**
+     * Star value (1-based index).
+     */
+    $implicit: number;
+    /**
+     * Style class of the icon.
+     */
+    class: string;
+}
+/**
+ * Defines valid templates in Rating.
+ * @group Templates
+ */
+interface RatingTemplates {
+    /**
+     * Custom on icon template.
+     * @param {RatingIconTemplateContext} context - icon context.
+     */
+    onicon(context: RatingIconTemplateContext): TemplateRef<RatingIconTemplateContext>;
+    /**
+     * Custom off icon template.
+     * @param {RatingIconTemplateContext} context - icon context.
+     */
+    officon(context: RatingIconTemplateContext): TemplateRef<RatingIconTemplateContext>;
+}
+
+export type { RatingIconTemplateContext, RatingPassThrough, RatingPassThroughOptions, RatingRateEvent, RatingTemplates };

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

@@ -0,0 +1,60 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Defines the scrollbar visibility variant for ScrollArea component.
+ * @group Types
+ */
+type ScrollAreaVariant = 'auto' | 'hover' | 'scroll' | 'always' | 'hidden';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ScrollArea.pt}
+ * @group Interface
+ */
+interface ScrollAreaPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the viewport's DOM element.
+     */
+    viewport?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the scrollbar's DOM element.
+     */
+    scrollbar?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the handle's DOM element.
+     */
+    handle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the corner's DOM element.
+     */
+    corner?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in ScrollArea component.
+ * @see {@link ScrollAreaPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ScrollAreaPassThrough<I = unknown> = PassThrough<I, ScrollAreaPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ScrollArea.
+ * @group Templates
+ */
+interface ScrollAreaTemplates {
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<void>;
+}
+
+export type { ScrollAreaPassThrough, ScrollAreaPassThroughOptions, ScrollAreaTemplates, ScrollAreaVariant };

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

@@ -0,0 +1,231 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Scroller.pt}
+ * @group Interface
+ */
+interface VirtualScrollerPassThroughOptions<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>;
+    /**
+     * Used to pass attributes to the spacer's DOM element.
+     */
+    spacer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loader's DOM element.
+     */
+    loader?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in VirtualScroller.
+ * @see {@link VirtualScrollerPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type VirtualScrollerPassThrough<I = unknown> = PassThrough<I, VirtualScrollerPassThroughOptions<I>>;
+/**
+ * Options of the scroll direction.
+ * @group Types
+ */
+type ScrollerToType = 'to-start' | 'to-end' | undefined;
+/**
+ * Options of the scroller orientation.
+ * @group Types
+ */
+type VirtualScrollerOrientationType = 'vertical' | 'horizontal' | 'both';
+/**
+ * Loader icon options.
+ * @group Types
+ */
+interface ScrollerLoaderIconOptions {
+    [klass: string]: any;
+}
+/**
+ * Scroller content options.
+ * @group Interface
+ */
+interface ScrollerContentOptions {
+    contentStyleClass?: string;
+    items?: any[];
+    loading?: boolean;
+    itemSize?: number;
+    rows?: any[];
+    columns?: any[];
+    spacerStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    contentStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    vertical?: boolean;
+    horizontal?: boolean;
+    both?: boolean;
+    getItemOptions?: (index: number) => ScrollerItemOptions;
+    getLoaderOptions?: (index: number, options?: any) => ScrollerLoaderOptions;
+}
+/**
+ * Scroller item options.
+ * @group Interface
+ */
+interface ScrollerItemOptions {
+    /**
+     * Index of the item.
+     */
+    index?: number;
+    /**
+     * Item count.
+     */
+    count?: number;
+    /**
+     * Index of the first element in viewport.
+     */
+    first?: boolean;
+    /**
+     * Index of the last element in viewport.
+     */
+    last?: boolean;
+    /**
+     * Defines if index is even number.
+     */
+    even?: boolean;
+    /**
+     * Defines if index is odd number.
+     */
+    odd?: boolean;
+}
+/**
+ * Loader settings.
+ * @extends {ScrollerItemOptions}
+ * @group Interface
+ */
+interface ScrollerLoaderOptions extends ScrollerItemOptions {
+    [klass: string]: any;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Scroller.onLazyLoad}
+ * @group Events
+ */
+interface ScrollerLazyLoadEvent {
+    /**
+     * First element index in viewport.
+     */
+    first: number;
+    /**
+     * Last element index in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom scroll index change event.
+ * @see {@link Scroller.onScrollIndexChange}
+ * @extends {ScrollerLazyLoadEvent}
+ * @group Events
+ */
+interface ScrollerScrollIndexChangeEvent extends ScrollerLazyLoadEvent {
+}
+/**
+ * Custom scroll event.
+ * @see {@link Scroller.onScroll}
+ * @group Events
+ */
+interface ScrollerScrollEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface ScrollerContentTemplateContext {
+    /**
+     * Loaded items.
+     */
+    $implicit: any[] | any | null | undefined;
+    /**
+     * Content options.
+     */
+    options: ScrollerContentOptions;
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface ScrollerItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: any;
+    /**
+     * Scroller item options.
+     */
+    options: ScrollerItemOptions;
+}
+/**
+ * Custom loader template context.
+ * @group Interface
+ */
+interface ScrollerLoaderTemplateContext {
+    /**
+     * Loader options.
+     */
+    options: ScrollerLoaderOptions;
+}
+/**
+ * Custom loader icon template context.
+ * @group Interface
+ */
+interface ScrollerLoaderIconTemplateContext {
+    /**
+     * Loader icon options.
+     */
+    options: ScrollerLoaderIconOptions;
+}
+/**
+ * Defines valid templates in Scroller.
+ * @group Templates
+ */
+interface ScrollerTemplates {
+    /**
+     * Custom content template.
+     * @param {ScrollerContentTemplateContext} context - content context.
+     */
+    content(context: ScrollerContentTemplateContext): TemplateRef<ScrollerContentTemplateContext>;
+    /**
+     * Custom item template.
+     * @param {ScrollerItemTemplateContext} context - item context.
+     */
+    item(context: ScrollerItemTemplateContext): TemplateRef<ScrollerItemTemplateContext>;
+    /**
+     * Custom loader template.
+     * @param {ScrollerLoaderTemplateContext} context - loader context.
+     */
+    loader(context: ScrollerLoaderTemplateContext): TemplateRef<ScrollerLoaderTemplateContext>;
+    /**
+     * Custom loader icon template.
+     * @param {ScrollerLoaderIconTemplateContext} context - loader icon context.
+     */
+    loadericon(context: ScrollerLoaderIconTemplateContext): TemplateRef<ScrollerLoaderIconTemplateContext>;
+}
+
+export type { ScrollerContentOptions, ScrollerContentTemplateContext, ScrollerItemOptions, ScrollerItemTemplateContext, ScrollerLazyLoadEvent, ScrollerLoaderIconOptions, ScrollerLoaderIconTemplateContext, ScrollerLoaderOptions, ScrollerLoaderTemplateContext, ScrollerScrollEvent, ScrollerScrollIndexChangeEvent, ScrollerTemplates, ScrollerToType, VirtualScrollerOrientationType, VirtualScrollerPassThrough, VirtualScrollerPassThroughOptions };

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

@@ -0,0 +1,56 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Defines the scroll orientation for ScrollPanel component.
+ * @group Types
+ */
+type ScrollPanelOrientation = 'vertical' | 'horizontal';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ScrollPanel.pt}
+ * @group Interface
+ */
+interface ScrollPanelPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: 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 horizontal panel's DOM element.
+     */
+    barX?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the vertical panel's DOM element.
+     */
+    barY?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in ScrollPanel component.
+ * @see {@link ScrollPanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ScrollPanelPassThrough<I = unknown> = PassThrough<I, ScrollPanelPassThroughOptions<I>>;
+/**
+ * Defines valid templates in ScrollPanel.
+ * @group Templates
+ */
+interface ScrollPanelTemplates {
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<void>;
+}
+
+export type { ScrollPanelOrientation, ScrollPanelPassThrough, ScrollPanelPassThroughOptions, ScrollPanelTemplates };