primenglab 22.0.0-beta.1

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

@@ -0,0 +1,180 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { MenuItem, PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Processed menu item used internally by PanelMenu.
+ */
+interface ProcessedMenuItem {
+    /**
+     * Unique key for the item.
+     */
+    key: string;
+    /**
+     * Original menu item.
+     */
+    item: MenuItem;
+    /**
+     * Child items.
+     */
+    items?: ProcessedMenuItem[];
+    /**
+     * Whether the item is expanded.
+     */
+    expanded?: boolean;
+    /**
+     * Whether this is a separator.
+     */
+    separator?: boolean;
+    /**
+     * Nesting level.
+     */
+    level: number;
+    /**
+     * Index within siblings.
+     */
+    index: number;
+    /**
+     * Parent processed item.
+     */
+    parent?: ProcessedMenuItem;
+    /**
+     * Parent item's key.
+     */
+    parentKey: string;
+    /**
+     * Item icon.
+     */
+    icon?: string;
+    /**
+     * Item badge.
+     */
+    badge?: string;
+}
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link PanelMenu.pt}
+ * @group Interface
+ */
+interface PanelMenuPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the panel's DOM element.
+     */
+    panel?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header content's DOM element.
+     */
+    headerContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header link's DOM element.
+     */
+    headerLink?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the submenu icon's DOM element.
+     */
+    submenuIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the header icon's DOM element.
+     */
+    headerIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the header label's DOM element.
+     */
+    headerLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the toggleable content's DOM element.
+     */
+    contentContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the toggleable content's DOM element.
+     */
+    contentWrapper?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the menu content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root list's DOM element.
+     */
+    rootList?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the submenu's DOM element.
+     */
+    submenu?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the item content's DOM element.
+     */
+    itemContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the item link's DOM element.
+     */
+    itemLink?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the item icon's DOM element.
+     */
+    itemIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the item label's DOM element.
+     */
+    itemLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in PanelMenu.
+ * @see {@link PanelMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PanelMenuPassThrough<I = unknown> = PassThrough<I, PanelMenuPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface PanelMenuItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: MenuItem;
+}
+/**
+ * Defines valid templates in PanelMenu.
+ * @group Templates
+ */
+interface PanelMenuTemplates {
+    /**
+     * Custom item template.
+     * @param {PanelMenuItemTemplateContext} context - item context.
+     */
+    item(context: PanelMenuItemTemplateContext): TemplateRef<PanelMenuItemTemplateContext>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<void>;
+    /**
+     * Custom template of headericon.
+     */
+    headericon(): TemplateRef<void>;
+}
+
+export type { PanelMenuItemTemplateContext, PanelMenuPassThrough, PanelMenuPassThroughOptions, PanelMenuTemplates, ProcessedMenuItem };

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

@@ -0,0 +1,120 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { InputTextPassThrough } from 'primenglab/types/inputtext';
+import { OverlayPassThrough } from 'primenglab/types/overlay';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Password.pt}
+ * @group Interface
+ */
+interface PasswordPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host element.
+     */
+    host?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the InputText component.
+     * @see {@link InputTextPassThrough}
+     */
+    pcInputText?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the mask icon's DOM element.
+     */
+    maskIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the unmask icon's DOM element.
+     */
+    unmaskIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Overlay component.
+     * @see {@link OverlayPassThrough}
+     */
+    pcOverlay?: OverlayPassThrough;
+    /**
+     * Used to pass attributes to the overlay's DOM element.
+     */
+    overlay?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter's DOM element.
+     */
+    meter?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter label's DOM element.
+     */
+    meterLabel?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter text's DOM element.
+     */
+    meterText?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in Password.
+ * @see {@link PasswordPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PasswordPassThrough<I = unknown> = PassThrough<I, PasswordPassThroughOptions<I>>;
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface PasswordIconTemplateContext {
+    /**
+     * Style class of the icon.
+     */
+    class: string;
+}
+/**
+ * Defines valid templates in Password.
+ * @group Templates
+ */
+interface PasswordTemplates {
+    /**
+     * Custom template of header.
+     */
+    header(): TemplateRef<void>;
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<void>;
+    /**
+     * Custom template of footer.
+     */
+    footer(): TemplateRef<void>;
+    /**
+     * Custom template of clear icon.
+     */
+    clearicon(): TemplateRef<void>;
+    /**
+     * Custom template of hide icon.
+     * @param {PasswordIconTemplateContext} context - icon context.
+     */
+    hideicon(context: PasswordIconTemplateContext): TemplateRef<PasswordIconTemplateContext>;
+    /**
+     * Custom template of show icon.
+     * @param {PasswordIconTemplateContext} context - icon context.
+     */
+    showicon(context: PasswordIconTemplateContext): TemplateRef<PasswordIconTemplateContext>;
+}
+
+export type { PasswordIconTemplateContext, PasswordPassThrough, PasswordPassThroughOptions, PasswordTemplates };

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

@@ -0,0 +1,358 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { ButtonPassThrough } from 'primenglab/types/button';
+import { ListBoxPassThrough } from 'primenglab/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
+ */
+interface PickListMoveAllToSourceEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move all to target event.
+ * @see {@link PickList.onMoveAllToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListMoveAllToTargetEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move to target event.
+ * @see {@link PickList.onMoveToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListMoveToTargetEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move source reorder event.
+ * @see {@link PickList.onSourceReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListSourceReorderEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move target reorder event.
+ * @see {@link PickList.onTargetReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+interface PickListTargetReorderEvent extends 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
+ */
+interface PickListTargetSelectEvent extends 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
+ */
+interface PickListTargetFilterEvent extends 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 shared by both lists. Used as a fallback when a list-specific template is not defined.
+     * @param {PickListItemTemplateContext} context - item context.
+     */
+    item(context: PickListItemTemplateContext): TemplateRef<PickListItemTemplateContext>;
+    /**
+     * Custom source item template, takes precedence over the shared item template for the source list.
+     * @param {PickListItemTemplateContext} context - item context.
+     */
+    sourceItem(context: PickListItemTemplateContext): TemplateRef<PickListItemTemplateContext>;
+    /**
+     * Custom target item template, takes precedence over the shared item template for the target list.
+     * @param {PickListItemTemplateContext} context - item context.
+     */
+    targetItem(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 };