@wawjs/ngx-prime 22.0.0

package/types/wawjs-ngx-prime-types-picklist.d.ts

@@ -0,0 +1,341 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@wawjs/ngx-prime/api';
+import { ButtonPassThrough } from '@wawjs/ngx-prime/types/button';
+import { ListBoxPassThrough } from '@wawjs/ngx-prime/types/listbox';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link PickList.pt}
+ * @group Interface
+ */
+interface PickListPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the source controls' DOM element.
+     */
+    sourceControls?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the source list container's DOM element.
+     */
+    sourceListContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the transfer controls' DOM element.
+     */
+    transferControls?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the target list container's DOM element.
+     */
+    targetListContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the target controls' DOM element.
+     */
+    targetControls?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the source move up Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveUpButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the source move top Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveTopButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the source move down Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveDownButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the source move bottom Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcSourceMoveBottomButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move to target Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveToTargetButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move all to target Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveAllToTargetButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move to source Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveToSourceButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the move all to source Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcMoveAllToSourceButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move up Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveUpButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move top Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveTopButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move down Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveDownButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the target move bottom Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcTargetMoveBottomButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the Listbox component.
+     * @see {@link ListBoxPassThrough}
+     */
+    pcListbox?: ListBoxPassThrough;
+}
+/**
+ * Defines valid pass-through options in PickList.
+ * @see {@link PickListPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PickListPassThrough<I = unknown> = PassThrough<I, PickListPassThroughOptions<I>>;
+/**
+ * Callbacks to invoke on filter.
+ * @group Interface
+ */
+interface PickListFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom move to source event.
+ * @see {@link PickList.onMoveToSource}
+ * @group Events
+ */
+interface PickListMoveToSourceEvent {
+    /**
+     * Moved items.
+     */
+    items: any[];
+}
+/**
+ * Custom move all to source event.
+ * @see {@link PickList.onMoveAllToSource}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+type PickListMoveAllToSourceEvent = PickListMoveToSourceEvent;
+/**
+ * Custom move all to target event.
+ * @see {@link PickList.onMoveAllToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+type PickListMoveAllToTargetEvent = PickListMoveToSourceEvent;
+/**
+ * Custom move to target event.
+ * @see {@link PickList.onMoveToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+type PickListMoveToTargetEvent = PickListMoveToSourceEvent;
+/**
+ * Custom move source reorder event.
+ * @see {@link PickList.onSourceReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+type PickListSourceReorderEvent = PickListMoveToSourceEvent;
+/**
+ * Custom move target reorder event.
+ * @see {@link PickList.onTargetReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+type PickListTargetReorderEvent = PickListMoveToSourceEvent;
+/**
+ * Custom source select event.
+ * @see {@link PickList.onSourceSelect}
+ * @group Events
+ */
+interface PickListSourceSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected items.
+     */
+    items: any[];
+}
+/**
+ * Custom target select event.
+ * @see {@link PickList.onTargetSelect}
+ * @extends {PickListSourceSelectEvent}
+ * @group Events
+ */
+type PickListTargetSelectEvent = PickListSourceSelectEvent;
+/**
+ * Custom source filter event.
+ * @see {@link PickList.onSourceFilter}
+ * @group Events
+ */
+interface PickListSourceFilterEvent {
+    /**
+     * Filter value.
+     */
+    query: string | null | undefined;
+    /**
+     * Filtered items.
+     */
+    value: any[] | null | undefined;
+}
+/**
+ * Custom target filter event.
+ * @see {@link PickList.onTargetFilter}
+ * @extends {PickListSourceFilterEvent}
+ * @group Events
+ */
+type PickListTargetFilterEvent = PickListSourceFilterEvent;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface PickListItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: any;
+    /**
+     * Item index.
+     */
+    index: number;
+    /**
+     * Whether the item is selected.
+     */
+    selected: boolean;
+    /**
+     * Whether the item is disabled.
+     */
+    disabled: boolean;
+}
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface PickListFilterTemplateContext {
+    /**
+     * Filter options.
+     */
+    options: PickListFilterOptions;
+}
+/**
+ * Custom transfer icon template context.
+ * @group Interface
+ */
+interface PickListTransferIconTemplateContext {
+    /**
+     * Boolean value indicates if the view is changed according to breakpoints.
+     */
+    $implicit: boolean;
+}
+/**
+ * Defines valid templates in PickList.
+ * @group Templates
+ */
+interface PickListTemplates {
+    /**
+     * Custom item template.
+     * @param {PickListItemTemplateContext} context - item context.
+     */
+    item(context: PickListItemTemplateContext): TemplateRef<PickListItemTemplateContext>;
+    /**
+     * Custom source header template.
+     */
+    sourceHeader(): TemplateRef<void>;
+    /**
+     * Custom target header template.
+     */
+    targetHeader(): TemplateRef<void>;
+    /**
+     * Custom source filter template.
+     * @param {PickListFilterTemplateContext} context - filter context.
+     */
+    sourceFilter(context: PickListFilterTemplateContext): TemplateRef<PickListFilterTemplateContext>;
+    /**
+     * Custom target filter template.
+     * @param {PickListFilterTemplateContext} context - filter context.
+     */
+    targetFilter(context: PickListFilterTemplateContext): TemplateRef<PickListFilterTemplateContext>;
+    /**
+     * Custom source list empty message template.
+     */
+    emptymessagesource(): TemplateRef<void>;
+    /**
+     * Custom source list empty filter message template.
+     */
+    emptyfiltermessagesource(): TemplateRef<void>;
+    /**
+     * Custom target list empty message template.
+     */
+    emptymessagetarget(): TemplateRef<void>;
+    /**
+     * Custom target list empty filter message template.
+     */
+    emptyfiltermessagetarget(): TemplateRef<void>;
+    /**
+     * Custom move up icon template.
+     */
+    moveupicon(): TemplateRef<void>;
+    /**
+     * Custom move top icon template.
+     */
+    movetopicon(): TemplateRef<void>;
+    /**
+     * Custom move down icon template.
+     */
+    movedownicon(): TemplateRef<void>;
+    /**
+     * Custom move bottom icon template.
+     */
+    movebottomicon(): TemplateRef<void>;
+    /**
+     * Custom move to target icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
+     */
+    movetotargeticon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
+    /**
+     * Custom move all to target icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
+     */
+    movealltotargeticon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
+    /**
+     * Custom move to source icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
+     */
+    movetosourceicon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
+    /**
+     * Custom move all to source icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
+     */
+    movealltosourceicon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
+    /**
+     * Custom target filter icon template.
+     */
+    targetfiltericon(): TemplateRef<void>;
+    /**
+     * Custom source filter icon template.
+     */
+    sourcefiltericon(): TemplateRef<void>;
+}
+
+export type { PickListFilterOptions, PickListFilterTemplateContext, PickListItemTemplateContext, PickListMoveAllToSourceEvent, PickListMoveAllToTargetEvent, PickListMoveToSourceEvent, PickListMoveToTargetEvent, PickListPassThrough, PickListPassThroughOptions, PickListSourceFilterEvent, PickListSourceReorderEvent, PickListSourceSelectEvent, PickListTargetFilterEvent, PickListTargetReorderEvent, PickListTargetSelectEvent, PickListTemplates, PickListTransferIconTemplateContext };

package/types/wawjs-ngx-prime-types-popover.d.ts

@@ -0,0 +1,59 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@wawjs/css-prime-motion';
+import { PassThrough, PassThroughOption } from '@wawjs/ngx-prime/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/wawjs-ngx-prime-types-progressbar.d.ts

@@ -0,0 +1,58 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@wawjs/ngx-prime/api';
+
+/**
+ * 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, ProgressBarPassThrough, ProgressBarPassThroughOptions, ProgressBarTemplates };

package/types/wawjs-ngx-prime-types-progressspinner.d.ts

@@ -0,0 +1,36 @@
+import { PassThrough, PassThroughOption } from '@wawjs/ngx-prime/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<SVGSVGElement, I>;
+    /**
+     * Used to pass attributes to the spin's DOM element.
+     */
+    spin?: PassThroughOption<SVGSVGElement, I>;
+    /**
+     * Used to pass attributes to the circle's DOM element.
+     */
+    circle?: PassThroughOption<SVGCircleElement, 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/wawjs-ngx-prime-types-radiobutton.d.ts

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

@@ -0,0 +1,94 @@
+import { PassThrough, PassThroughOption } from '@wawjs/ngx-prime/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 };