primenglab 22.0.0-beta.1

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

@@ -0,0 +1,154 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { MenuPassThrough } from 'primenglab/types/menu';
+
+/**
+ * Defines valid pass-through options in CommandMenu component.
+ * @template I Type of instance.
+ *
+ * @see {@link CommandMenu.pt}
+ * @group Interface
+ */
+interface CommandMenuPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the input's DOM element.
+     */
+    input?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the Menu component.
+     */
+    pcMenu?: MenuPassThrough;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in CommandMenu component.
+ * @see {@link CommandMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type CommandMenuPassThrough<I = unknown> = PassThrough<I, CommandMenuPassThroughOptions<I>>;
+/**
+ * Custom item select event.
+ * @group Events
+ */
+interface CommandMenuItemSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected menu item.
+     */
+    item: any;
+}
+/**
+ * Custom search change event.
+ * @group Events
+ */
+interface CommandMenuSearchChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Search query value.
+     */
+    query: string;
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface CommandMenuItemTemplateContext<T = any> {
+    /**
+     * Data of the option.
+     */
+    $implicit: T;
+}
+/**
+ * Custom header template context.
+ * @group Interface
+ */
+interface CommandMenuHeaderTemplateContext {
+    /**
+     * Current search value.
+     */
+    $implicit: string;
+}
+/**
+ * Custom footer template context.
+ * @group Interface
+ */
+interface CommandMenuFooterTemplateContext {
+    /**
+     * Current search value.
+     */
+    $implicit: string;
+}
+/**
+ * Custom empty template context.
+ * @group Interface
+ */
+interface CommandMenuEmptyMessageTemplateContext {
+    /**
+     * Current search value.
+     */
+    $implicit: string;
+}
+/**
+ * Defines valid templates in CommandMenu.
+ * @group Templates
+ */
+interface CommandMenuTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - item data.
+     */
+    item(context: CommandMenuItemTemplateContext): TemplateRef<CommandMenuItemTemplateContext>;
+    /**
+     * Custom header template.
+     * @param {Object} context - header context.
+     */
+    header(context: CommandMenuHeaderTemplateContext): TemplateRef<CommandMenuHeaderTemplateContext>;
+    /**
+     * Custom footer template.
+     * @param {Object} context - footer context.
+     */
+    footer(context: CommandMenuFooterTemplateContext): TemplateRef<CommandMenuFooterTemplateContext>;
+    /**
+     * Custom empty message template.
+     * @param {Object} context - empty message context.
+     */
+    emptyMessage(context: CommandMenuEmptyMessageTemplateContext): TemplateRef<CommandMenuEmptyMessageTemplateContext>;
+}
+/**
+ * Defines context options for CommandMenu passthrough.
+ * @group Interface
+ */
+interface CommandMenuContext {
+    /**
+     * Whether the option is focused.
+     */
+    focused?: boolean;
+    /**
+     * Whether the option is disabled.
+     */
+    disabled?: boolean;
+}
+
+export type { CommandMenuContext, CommandMenuEmptyMessageTemplateContext, CommandMenuFooterTemplateContext, CommandMenuHeaderTemplateContext, CommandMenuItemSelectEvent, CommandMenuItemTemplateContext, CommandMenuPassThrough, CommandMenuPassThroughOptions, CommandMenuSearchChangeEvent, CommandMenuTemplates };

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

@@ -0,0 +1,55 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Defines valid pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Compare.pt}
+ * @group Interface
+ */
+interface ComparePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the handle's DOM element.
+     */
+    handle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the indicator's DOM element.
+     */
+    indicator?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the input's DOM element.
+     */
+    input?: PassThroughOption<HTMLInputElement, I>;
+}
+/**
+ * Defines valid pass-through options in Compare component.
+ * @see {@link ComparePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ComparePassThrough<I = unknown> = PassThrough<I, ComparePassThroughOptions<I>>;
+/**
+ * Custom value change event.
+ * @see {@link Compare.onValueChange}
+ * @group Events
+ */
+interface CompareValueChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * New value.
+     */
+    value: number;
+}
+
+export type { ComparePassThrough, ComparePassThroughOptions, CompareValueChangeEvent };

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

@@ -0,0 +1,161 @@
+import { TemplateRef } from '@angular/core';
+import { Confirmation, PassThrough, PassThroughOption } from 'primenglab/api';
+import { DialogPassThrough } from 'primenglab/types/dialog';
+import { ButtonPassThrough } from 'primenglab/types/button';
+import { MotionOptions } from '@primeuix/motion';
+
+/**
+ * Element to receive the focus when the dialog gets visible.
+ * @group Types
+ */
+type ConfirmDialogDefaultFocus = 'accept' | 'reject' | 'close' | 'none';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ConfirmDialog.pt}
+ * @group Interface
+ */
+interface ConfirmDialogPassThroughOptions<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.
+     * @see {@link DialogPassThrough}
+     */
+    root?: DialogPassThrough;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the resize handle's DOM element.
+     */
+    resizeHandle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the title's DOM element.
+     */
+    title?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the header actions' DOM element.
+     */
+    headerActions?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the close Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcCloseButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the accept Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAcceptButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the reject Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcRejectButton?: ButtonPassThrough;
+    /**
+     * 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 ConfirmDialog.
+ * @see {@link ConfirmDialogPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ConfirmDialogPassThrough<I = unknown> = PassThrough<I, ConfirmDialogPassThroughOptions<I>>;
+/**
+ * Custom headless template context.
+ * @group Interface
+ */
+interface ConfirmDialogHeadlessTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+    /**
+     * Callback to accept the confirmation.
+     */
+    onAccept: () => void;
+    /**
+     * Callback to reject the confirmation.
+     */
+    onReject: () => void;
+}
+/**
+ * Custom message template context.
+ * @group Interface
+ */
+interface ConfirmDialogMessageTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+}
+/**
+ * Defines valid templates in ConfirmDialog.
+ * @group Templates
+ */
+interface ConfirmDialogTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<void>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<void>;
+    /**
+     * Custom message template.
+     * @param {Object} context - message context.
+     */
+    message(context: ConfirmDialogMessageTemplateContext): TemplateRef<ConfirmDialogMessageTemplateContext>;
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<void>;
+    /**
+     * Custom reject icon template.
+     */
+    rejecticon(): TemplateRef<void>;
+    /**
+     * Custom accept icon template.
+     */
+    accepticon(): TemplateRef<void>;
+    /**
+     * Custom headless template.
+     * @param {Object} context - headless context.
+     */
+    headless(context: ConfirmDialogHeadlessTemplateContext): TemplateRef<ConfirmDialogHeadlessTemplateContext>;
+}
+
+export type { ConfirmDialogDefaultFocus, ConfirmDialogHeadlessTemplateContext, ConfirmDialogMessageTemplateContext, ConfirmDialogPassThrough, ConfirmDialogPassThroughOptions, ConfirmDialogTemplates };

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

@@ -0,0 +1,110 @@
+import { Confirmation, PassThrough, PassThroughOption } from 'primenglab/api';
+import { ButtonPassThrough } from 'primenglab/types/button';
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+
+/**
+ * Element to receive the focus when the popup gets visible.
+ * @group Types
+ */
+type ConfirmPopupDefaultFocus = 'accept' | 'reject' | 'none';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ConfirmPopup.pt}
+ * @group Interface
+ */
+interface ConfirmPopupPassThroughOptions<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 icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the reject Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcRejectButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the accept Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAcceptButton?: ButtonPassThrough;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in ConfirmPopup.
+ * @see {@link ConfirmPopupPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ConfirmPopupPassThrough<I = unknown> = PassThrough<I, ConfirmPopupPassThroughOptions<I>>;
+/**
+ * Custom headless template context.
+ * @group Interface
+ */
+interface ConfirmPopupHeadlessTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+}
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface ConfirmPopupContentTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+}
+/**
+ * Defines valid templates in ConfirmPopup.
+ * @group Templates
+ */
+interface ConfirmPopupTemplates {
+    /**
+     * Custom content template.
+     * @param {Object} context - content context.
+     */
+    content(context: ConfirmPopupContentTemplateContext): TemplateRef<ConfirmPopupContentTemplateContext>;
+    /**
+     * Custom reject icon template.
+     */
+    rejecticon(): TemplateRef<void>;
+    /**
+     * Custom accept icon template.
+     */
+    accepticon(): TemplateRef<void>;
+    /**
+     * Custom headless template.
+     * @param {Object} context - headless context.
+     */
+    headless(context: ConfirmPopupHeadlessTemplateContext): TemplateRef<ConfirmPopupHeadlessTemplateContext>;
+}
+
+export type { ConfirmPopupContentTemplateContext, ConfirmPopupDefaultFocus, ConfirmPopupHeadlessTemplateContext, ConfirmPopupPassThrough, ConfirmPopupPassThroughOptions, ConfirmPopupTemplates };

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

@@ -0,0 +1,135 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { MenuItem, PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ContextMenu.pt}
+ * @group Interface
+ */
+interface ContextMenuPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: 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 separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, 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 submenu icon's DOM element.
+     */
+    submenuIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in ContextMenu.
+ * @see {@link ContextMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ContextMenuPassThrough<I = unknown> = PassThrough<I, ContextMenuPassThroughOptions<I>>;
+/**
+ * Processed menu item used internally.
+ */
+interface ContextMenuProcessedItem {
+    /**
+     * Menu item instance.
+     */
+    item: MenuItem;
+    /**
+     * Index of the item in its parent.
+     */
+    index: number;
+    /**
+     * Nesting level of the item.
+     */
+    level: number;
+    /**
+     * Unique key of the item.
+     */
+    key: string;
+    /**
+     * Parent processed item.
+     */
+    parent: ContextMenuProcessedItem | Record<string, never>;
+    /**
+     * Parent key.
+     */
+    parentKey: string;
+    /**
+     * Child processed items.
+     */
+    items?: ContextMenuProcessedItem[];
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface ContextMenuItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+}
+/**
+ * Custom submenu icon template context.
+ * @group Interface
+ */
+interface ContextMenuSubmenuIconTemplateContext {
+    /**
+     * Style class of the submenu icon.
+     */
+    class: string;
+}
+/**
+ * Defines valid templates in ContextMenu.
+ * @group Templates
+ */
+interface ContextMenuTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - item context.
+     */
+    item(context: ContextMenuItemTemplateContext): TemplateRef<ContextMenuItemTemplateContext>;
+    /**
+     * Custom submenu icon template.
+     * @param {Object} context - icon context.
+     */
+    submenuicon(context: ContextMenuSubmenuIconTemplateContext): TemplateRef<ContextMenuSubmenuIconTemplateContext>;
+}
+
+export type { ContextMenuItemTemplateContext, ContextMenuPassThrough, ContextMenuPassThroughOptions, ContextMenuProcessedItem, ContextMenuSubmenuIconTemplateContext, ContextMenuTemplates };