primenglab 22.0.0-beta.1

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

@@ -0,0 +1,187 @@
+import { TemplateRef } from '@angular/core';
+import { TreeNode, PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Represents a node in the OrganizationChart with additional properties.
+ * @extends TreeNode
+ * @group Interface
+ */
+interface OrgChartNode<T = any> extends TreeNode<T> {
+    /**
+     * An array of child nodes.
+     */
+    children?: OrgChartNode<T>[];
+    /**
+     * Whether the node can be collapsed/expanded.
+     */
+    collapsible?: boolean;
+    /**
+     * Whether the node should be selected by default.
+     * @deprecated since v22, use selectionKeys input.
+     * @defaultValue false
+     */
+    selectedByDefault?: boolean;
+    /**
+     * Whether the node should be collapsed by default.
+     * @deprecated since v22, use collapsedKeys input.
+     * @defaultValue false
+     */
+    collapsedByDefault?: boolean;
+}
+/**
+ * Defines the selection mode.
+ */
+type OrganizationChartSelectionMode = 'single' | 'multiple';
+/**
+ * A map keyed by `OrgChartNode.key` used to track selection or collapsed state.
+ * A node is considered selected/collapsed when its key maps to `true`.
+ * @group Types
+ */
+type OrganizationChartNodeKeys = {
+    [key: string]: boolean;
+};
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link OrganizationChart.pt}
+ * @group Interface
+ */
+interface OrganizationChartPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the subtree's DOM element.
+     */
+    subtree?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the tree's DOM element.
+     */
+    tree?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the node's DOM element.
+     */
+    node?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the node content's DOM element.
+     */
+    nodeContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the collapse button's DOM element.
+     */
+    collapseButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the collapse button down icon's DOM element.
+     */
+    collapseButtonDownIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the collapse button up icon's DOM element.
+     */
+    collapseButtonUpIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in OrganizationChart.
+ * @see {@link OrganizationChartPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type OrganizationChartPassThrough<I = unknown> = PassThrough<I, OrganizationChartPassThroughOptions<I>>;
+/**
+ * Custom node select event.
+ * @see {@link OrganizationChart.onNodeSelect}
+ * @group Events
+ */
+interface OrganizationChartNodeSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Node instance.
+     */
+    node: OrgChartNode;
+}
+/**
+ * Custom node unselect event.
+ * @see {@link OrganizationChart.onNodeUnSelect}
+ * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
+ */
+interface OrganizationChartNodeUnSelectEvent extends OrganizationChartNodeSelectEvent {
+}
+/**
+ * Custom node expand event.
+ * @see {@link OrganizationChart.onNodeExpand}
+ * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
+ */
+interface OrganizationChartNodeExpandEvent extends OrganizationChartNodeSelectEvent {
+}
+/**
+ * Custom node collapse event.
+ * @see {@link OrganizationChart.onNodeCollapse}
+ * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
+ */
+interface OrganizationChartNodeCollapseEvent extends OrganizationChartNodeSelectEvent {
+}
+/**
+ * Defines valid templates in OrganizationChart.
+ * @group Templates
+ */
+interface OrganizationChartTemplates {
+    /**
+     * Custom node template.
+     * @param {Object} context - node data.
+     */
+    node(context: {
+        /**
+         * Node instance.
+         */
+        $implicit: OrgChartNode;
+    }): TemplateRef<{
+        $implicit: OrgChartNode;
+    }>;
+    /**
+     * Custom toggler icon template.
+     * @param {Object} context - item data.
+     */
+    togglericon(context: {
+        /**
+         * Expanded state of the node.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom collapse button template.
+     * @param {Object} context - collapse button data.
+     */
+    collapsebutton(context: {
+        /**
+         * Node instance.
+         */
+        $implicit: OrgChartNode;
+        /**
+         * Whether the node is expanded.
+         */
+        expanded: boolean;
+        /**
+         * Whether the node is collapsed.
+         */
+        collapsed: boolean;
+        /**
+         * Number of child nodes.
+         */
+        childCount: number;
+        /**
+         * Function to toggle the node.
+         */
+        toggle: (event: Event, node: OrgChartNode) => void;
+    }): TemplateRef<any>;
+}
+
+export type { OrgChartNode, OrganizationChartNodeCollapseEvent, OrganizationChartNodeExpandEvent, OrganizationChartNodeKeys, OrganizationChartNodeSelectEvent, OrganizationChartNodeUnSelectEvent, OrganizationChartPassThrough, OrganizationChartPassThroughOptions, OrganizationChartSelectionMode, OrganizationChartTemplates };

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

@@ -0,0 +1,60 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { OverlayModeType, PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface OverlayContentTemplateContext {
+    /**
+     * Object containing the overlay mode.
+     */
+    $implicit: {
+        /**
+         * Current overlay mode.
+         */
+        mode: OverlayModeType | string | null;
+    };
+}
+/**
+ * Defines valid templates in Overlay.
+ * @group Templates
+ */
+interface OverlayTemplates {
+    /**
+     * Custom content template.
+     * @param {OverlayContentTemplateContext} context - content context.
+     */
+    content(context: OverlayContentTemplateContext): TemplateRef<OverlayContentTemplateContext>;
+}
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link OverlayProps.pt}
+ * @group Interface
+ */
+interface OverlayPassThroughOptions<I = unknown> {
+    /**
+     * 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 Overlay component.
+ * @see {@link OverlayPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type OverlayPassThrough<I = unknown> = PassThrough<I, OverlayPassThroughOptions<I>>;
+
+export type { OverlayContentTemplateContext, OverlayPassThrough, OverlayPassThroughOptions, OverlayTemplates };

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

@@ -0,0 +1,34 @@
+import { BadgePassThrough } from 'primenglab/types/badge';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link OverlayBadgeProps.pt}
+ * @group Interface
+ */
+interface OverlayBadgePassThroughOptions<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 Badge component.
+     * @see {@link BadgePassThrough}
+     */
+    pcBadge?: BadgePassThrough;
+}
+/**
+ * Defines valid pass-through options in OverlayBadge.
+ * @see {@link OverlayBadgePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type OverlayBadgePassThrough<I = unknown> = PassThrough<I, OverlayBadgePassThroughOptions<I>>;
+
+export type { OverlayBadgePassThrough, OverlayBadgePassThroughOptions };

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

@@ -0,0 +1,167 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { InputNumberPassThrough } from 'primenglab/types/inputnumber';
+import { SelectPassThrough } from 'primenglab/types/select';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Paginator.pt}
+ * @group Interface
+ */
+interface PaginatorPassThroughOptions<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 start's DOM element.
+     */
+    contentStart?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the current page report's DOM element.
+     */
+    current?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the first page button's DOM element.
+     */
+    first?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the first page button icon's DOM element.
+     */
+    firstIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the previous page button's DOM element.
+     */
+    prev?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the previous page button icon's DOM element.
+     */
+    prevIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the pages container's DOM element.
+     */
+    pages?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the page button's DOM element.
+     */
+    page?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the next page button's DOM element.
+     */
+    next?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the next page button icon's DOM element.
+     */
+    nextIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the last page button's DOM element.
+     */
+    last?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the last page button icon's DOM element.
+     */
+    lastIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the content end's DOM element.
+     */
+    contentEnd?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Select component (jump to page dropdown).
+     */
+    pcJumpToPageDropdown?: SelectPassThrough;
+    /**
+     * Used to pass attributes to the InputNumber component (jump to page input).
+     */
+    pcJumpToPageInput?: InputNumberPassThrough;
+    /**
+     * Used to pass attributes to the Select component (rows per page dropdown).
+     */
+    pcRowPerPageDropdown?: SelectPassThrough;
+}
+/**
+ * Defines valid pass-through options in Paginator.
+ * @see {@link PaginatorPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PaginatorPassThrough<I = unknown> = PassThrough<I, PaginatorPassThroughOptions<I>>;
+/**
+ * Paginator state.
+ * @group Interface
+ */
+interface PaginatorState {
+    /**
+     * Current page number.
+     */
+    page?: number;
+    /**
+     * Index of the first record.
+     */
+    first?: number;
+    /**
+     * Number of rows per page.
+     */
+    rows?: number;
+    /**
+     * Total number of pages.
+     */
+    pageCount?: number;
+    /**
+     * Total number of records.
+     */
+    totalRecords?: number;
+}
+/**
+ * Custom template context for left/right templates.
+ * @group Interface
+ */
+interface PaginatorTemplateContext {
+    /**
+     * Paginator state.
+     */
+    $implicit: PaginatorState;
+}
+/**
+ * Custom template context for dropdown item templates.
+ * @group Interface
+ */
+interface PaginatorDropdownItemTemplateContext {
+    /**
+     * Dropdown item instance.
+     */
+    $implicit: any;
+}
+/**
+ * Defines valid templates in PaginatorTemplates.
+ * @group Templates
+ */
+interface PaginatorTemplates {
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    dropdownicon(): TemplateRef<void>;
+    /**
+     * Custom first page link icon template.
+     */
+    firstpagelinkicon(): TemplateRef<void>;
+    /**
+     * Custom previous page link icon template.
+     */
+    previouspagelinkicon(): TemplateRef<void>;
+    /**
+     * Custom last page link icon template.
+     */
+    lastpagelinkicon(): TemplateRef<void>;
+    /**
+     * Custom next page link icon template.
+     */
+    nextpagelinkicon(): TemplateRef<void>;
+}
+
+export type { PaginatorDropdownItemTemplateContext, PaginatorPassThrough, PaginatorPassThroughOptions, PaginatorState, PaginatorTemplateContext, PaginatorTemplates };

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

@@ -0,0 +1,139 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { ButtonPassThrough } from 'primenglab/types/button';
+
+/**
+ * Defines the icon position for Panel component.
+ * @group Types
+ */
+type PanelIconPos = 'start' | 'end' | 'center';
+/**
+ * Defines the toggler element for Panel component.
+ * @group Types
+ */
+type PanelToggler = 'icon' | 'header';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Panel.pt}
+ * @group Interface
+ */
+interface PanelPassThroughOptions<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 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 toggle button button's DOM element.
+     * @see {@link ButtonPassThroughOptions}
+     */
+    pcToggleButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the content container's DOM element.
+     */
+    contentContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content wrapper DOM element.
+     */
+    contentWrapper?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * 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 options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in Panel component.
+ * @see {@link PanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type PanelPassThrough<I = unknown> = PassThrough<I, PanelPassThroughOptions<I>>;
+/**
+ * Custom panel toggle event, emits before panel toggle.
+ * @see {@link onBeforeToggle}
+ * @group Interface
+ */
+interface PanelBeforeToggleEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Collapsed state of the panel.
+     */
+    collapsed: boolean | undefined;
+}
+/**
+ * Custom panel toggle event, emits after panel toggle.
+ * @see {@link onAfterToggle}
+ * @extends {PanelBeforeToggleEvent}
+ * @group Interface
+ */
+interface PanelAfterToggleEvent extends PanelBeforeToggleEvent {
+}
+/**
+ * Toggle icon template context.
+ * @param {boolean} $implicit - Collapsed state as a boolean, implicit value.
+ * @group Interface
+ */
+interface PanelHeaderIconsTemplateContext {
+    /**
+     * Collapsed state as a boolean, implicit value.
+     */
+    $implicit: boolean;
+}
+/**
+ * Defines valid templates in Panel.
+ * @group Templates
+ */
+interface PanelTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<void>;
+    /**
+     * Custom icons template.
+     */
+    icons(): TemplateRef<void>;
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<void>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<void>;
+    /**
+     * Custom header icons template.
+     * @param {PanelHeaderIconsTemplateContext} context - header icons context.
+     */
+    headericons(context: PanelHeaderIconsTemplateContext): TemplateRef<PanelHeaderIconsTemplateContext>;
+}
+
+export type { PanelAfterToggleEvent, PanelBeforeToggleEvent, PanelHeaderIconsTemplateContext, PanelIconPos, PanelPassThrough, PanelPassThroughOptions, PanelTemplates, PanelToggler };