primenglab 22.0.0-beta.1

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

@@ -0,0 +1,91 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Position of the icon.
+ * @group Types
+ */
+type ToggleButtonIconPos = 'left' | 'right';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ToggleButtonProps.pt}
+ * @group Interface
+ */
+interface ToggleButtonPassThroughOptions<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<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type ToggleButtonPassThrough<I = unknown> = PassThrough<I, ToggleButtonPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link ToggleButton.onChange}
+ * @group Events
+ */
+interface ToggleButtonChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Checked state as a boolean.
+     */
+    checked: boolean;
+}
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface ToggleButtonIconTemplateContext {
+    /**
+     * Checked state.
+     */
+    $implicit: boolean;
+}
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface ToggleButtonContentTemplateContext {
+    /**
+     * Checked state.
+     */
+    $implicit: boolean;
+}
+/**
+ * Defines valid templates in ToggleButton.
+ * @group Templates
+ */
+interface ToggleButtonTemplates {
+    /**
+     * Custom icon template.
+     * @param {ToggleButtonIconTemplateContext} context - icon context.
+     */
+    icon(context: ToggleButtonIconTemplateContext): TemplateRef<ToggleButtonIconTemplateContext>;
+    /**
+     * Custom content template.
+     * @param {ToggleButtonContentTemplateContext} context - content context.
+     */
+    content(context: ToggleButtonContentTemplateContext): TemplateRef<ToggleButtonContentTemplateContext>;
+}
+
+export type { ToggleButtonChangeEvent, ToggleButtonContentTemplateContext, ToggleButtonIconPos, ToggleButtonIconTemplateContext, ToggleButtonPassThrough, ToggleButtonPassThroughOptions, ToggleButtonTemplates };

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

@@ -0,0 +1,73 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom passthrough(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ToggleSwitch.pt}
+ * @group Interface
+ */
+interface ToggleSwitchPassThroughOptions<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 slider's DOM element.
+     */
+    slider?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the handle's DOM element.
+     */
+    handle?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in ToggleSwitch component.
+ * @see {@link ToggleSwitchPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ToggleSwitchPassThrough<I = unknown> = PassThrough<I, ToggleSwitchPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link ToggleSwitch.onChange}
+ * @group Events
+ */
+interface ToggleSwitchChangeEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Checked state as a boolean.
+     */
+    checked: boolean;
+}
+/**
+ * Custom handle template context.
+ * @group Interface
+ */
+interface ToggleSwitchHandleTemplateContext {
+    /**
+     * Checked state of the toggle switch.
+     */
+    checked: boolean;
+}
+/**
+ * Defines valid templates in ToggleSwitch.
+ * @group Templates
+ */
+interface ToggleSwitchTemplates {
+    /**
+     * Custom handle template.
+     * @param {ToggleSwitchHandleTemplateContext} context - handle context.
+     */
+    handle(context: ToggleSwitchHandleTemplateContext): TemplateRef<ToggleSwitchHandleTemplateContext>;
+}
+
+export type { ToggleSwitchChangeEvent, ToggleSwitchHandleTemplateContext, ToggleSwitchPassThrough, ToggleSwitchPassThroughOptions, ToggleSwitchTemplates };

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

@@ -0,0 +1,55 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Toolbar.pt}
+ * @group Interface
+ */
+interface ToolbarPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the start's DOM element.
+     */
+    start?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the center's DOM element.
+     */
+    center?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the right's DOM element.
+     */
+    end?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Toolbar component.
+ * @see {@link ToolbarPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ToolbarPassThrough<I = unknown> = PassThrough<I, ToolbarPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Toolbar.
+ * @group Templates
+ */
+interface ToolbarTemplates {
+    /**
+     * Custom start template.
+     */
+    start(): TemplateRef<void>;
+    /**
+     * Custom end template.
+     */
+    end(): TemplateRef<void>;
+    /**
+     * Custom center template.
+     */
+    center(): TemplateRef<void>;
+}
+
+export type { ToolbarPassThrough, ToolbarPassThroughOptions, ToolbarTemplates };

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

@@ -0,0 +1,42 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Defines the position of the tooltip.
+ * @group Types
+ */
+type TooltipPosition = 'right' | 'left' | 'top' | 'bottom';
+/**
+ * Defines the event that triggers the tooltip.
+ * @group Types
+ */
+type TooltipEvent = 'hover' | 'focus' | 'both';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Tooltip.pt}
+ * @group Interface
+ */
+interface TooltipPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the arrow's DOM element.
+     */
+    arrow?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the text's DOM element.
+     */
+    text?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tooltip.
+ * @see {@link TooltipPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TooltipPassThrough<I = unknown> = PassThrough<I, TooltipPassThroughOptions<I>>;
+
+export type { TooltipEvent, TooltipPassThrough, TooltipPassThroughOptions, TooltipPosition };

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

@@ -0,0 +1,355 @@
+import { TemplateRef } from '@angular/core';
+import { TreeNode, ScrollerOptions, PassThrough, PassThroughOption } from 'primenglab/api';
+import { CheckboxPassThrough } from 'primenglab/types/checkbox';
+import { IconFieldPassThrough } from 'primenglab/types/iconfield';
+import { InputIconPassThrough } from 'primenglab/types/inputicon';
+import { InputTextPassThrough } from 'primenglab/types/inputtext';
+import { VirtualScrollerPassThrough } from 'primenglab/types/scroller';
+
+/**
+ * Defines the selection mode of the tree.
+ */
+type TreeSelectionMode = 'single' | 'multiple' | 'checkbox' | null | undefined;
+/**
+ * Defines the loading mode of the tree.
+ */
+type TreeLoadingMode = 'mask' | 'icon';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Tree.pt}
+ * @group Interface
+ */
+interface TreePassThroughOptions<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 loading mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the filter container's DOM element.
+     */
+    pcFilterContainer?: IconFieldPassThrough;
+    /**
+     * Used to pass attributes to the filter icon container's DOM element.
+     */
+    pcFilterIconContainer?: InputIconPassThrough;
+    /**
+     * Used to pass attributes to the filter input's DOM element.
+     */
+    pcFilterInput?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the filter icon's DOM element.
+     */
+    filterIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Scroller component.
+     */
+    pcScroller?: VirtualScrollerPassThrough;
+    /**
+     * Used to pass attributes to the wrapper's DOM element.
+     */
+    wrapper?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root children's DOM element.
+     */
+    rootChildren?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the node's DOM element.
+     */
+    node?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the drop point's DOM element.
+     */
+    dropPoint?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the node content's DOM element.
+     */
+    nodeContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the node toggle button's DOM element.
+     */
+    nodeToggleButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the node toggle icon's DOM element.
+     */
+    nodeTogglerIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the node checkbox's DOM element.
+     */
+    pcNodeCheckbox?: CheckboxPassThrough;
+    /**
+     * Used to pass attributes to the node icon's DOM element.
+     */
+    nodeIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the node label's DOM element.
+     */
+    nodeLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the node children's DOM element.
+     */
+    nodeChildren?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tree.
+ * @see {@link TreePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TreePassThrough<I = unknown> = PassThrough<I, TreePassThroughOptions<I>>;
+/**
+ * Custom node select event.
+ * @see {@link Tree.onNodeSelect}
+ * @group Events
+ */
+interface TreeNodeSelectEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Node instance.
+     */
+    node: TreeNode<any>;
+}
+/**
+ * Custom node unselect event.
+ * @see {@link Tree.onNodeUnSelect}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeUnSelectEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node expand event.
+ * @see {@link Tree.onNodeExpand}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeExpandEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node collapse event.
+ * @see {@link Tree.onNodeCollapse}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeCollapseEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom context menu select event.
+ * @see {@link Tree.onNodeContextMenuSelect}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeContextMenuSelectEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node double click event.
+ * @see {@link Tree.onNodeDoubleClick}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+interface TreeNodeDoubleClickEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node drop event.
+ * @see {@link Tree.onNodeDrop}
+ * @group Events
+ */
+interface TreeNodeDropEvent {
+    /**
+     * Browser drag event.
+     */
+    originalEvent?: DragEvent;
+    /**
+     * Dragged node instance.
+     */
+    dragNode?: TreeNode<any> | null;
+    /**
+     * Dropped node instance.
+     */
+    dropNode?: TreeNode<any> | null;
+    /**
+     * Index of the dragged node.
+     */
+    index?: number;
+    /**
+     * Indicates if the node is dropped onto a node (`'node'`) or in a drop point
+     * between nodes (`'between'`).
+     */
+    dropPoint?: 'node' | 'between';
+    /**
+     * Callback to invoke on drop.
+     */
+    accept?: Function;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Tree.onLazyLoad}
+ * @group Events
+ */
+interface TreeLazyLoadEvent {
+    /**
+     * First element index in viewport.
+     */
+    first: number;
+    /**
+     * Last element index in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom scroll index change event.
+ * @see {@link Tree.onScrollIndexChange}
+ * @group Events
+ */
+interface TreeScrollIndexChangeEvent extends TreeLazyLoadEvent {
+}
+/**
+ * Custom scroll event.
+ * @see {@link Tree.onScroll}
+ * @group Events
+ */
+interface TreeScrollEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Custom filter event.
+ * @see {@link Tree.onFilter}
+ * @group Events
+ */
+interface TreeFilterEvent {
+    /**
+     * Filter value.
+     */
+    filter: string;
+    /**
+     * Filtered nodes.
+     */
+    filteredValue: TreeNode<any>[] | null | undefined;
+}
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface TreeFilterTemplateContext {
+    /**
+     * Filter options with filter and reset methods.
+     */
+    $implicit: {
+        filter: (value: string) => void;
+        reset: () => void;
+    };
+}
+/**
+ * Custom loader template context.
+ * @group Interface
+ */
+interface TreeLoaderTemplateContext {
+    /**
+     * Scroller options.
+     * @see {@link ScrollerOptions}
+     */
+    options: ScrollerOptions;
+}
+/**
+ * Custom toggler icon template context.
+ * @group Interface
+ */
+interface TreeTogglerIconTemplateContext {
+    /**
+     * Expanded state of the node.
+     */
+    $implicit: boolean;
+    /**
+     * Loading state of the node.
+     */
+    loading: boolean;
+}
+/**
+ * Custom checkbox icon template context.
+ * @group Interface
+ */
+interface TreeCheckboxIconTemplateContext {
+    /**
+     * Checked state of the node.
+     */
+    $implicit: boolean;
+    /**
+     * Partial selection state of the node.
+     */
+    partialSelected: boolean;
+    /**
+     * Style class of the checkbox.
+     */
+    class: string;
+}
+/**
+ * Defines valid templates in Tree.
+ * @group Templates
+ */
+interface TreeTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<void>;
+    /**
+     * Custom empty message template.
+     */
+    empty(): TemplateRef<void>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<void>;
+    /**
+     * Custom filter template.
+     * @param {TreeFilterTemplateContext} context - filter context.
+     */
+    filter(context: TreeFilterTemplateContext): TemplateRef<TreeFilterTemplateContext>;
+    /**
+     * Custom loader template.
+     * @param {TreeLoaderTemplateContext} context - loader context.
+     */
+    loader(context: TreeLoaderTemplateContext): TemplateRef<TreeLoaderTemplateContext>;
+    /**
+     * Custom toggler icon template.
+     * @param {TreeTogglerIconTemplateContext} context - toggler icon context.
+     */
+    togglericon(context: TreeTogglerIconTemplateContext): TemplateRef<TreeTogglerIconTemplateContext>;
+    /**
+     * Custom checkbox icon template.
+     * @param {TreeCheckboxIconTemplateContext} context - checkbox icon context.
+     */
+    checkboxicon(context: TreeCheckboxIconTemplateContext): TemplateRef<TreeCheckboxIconTemplateContext>;
+    /**
+     * Custom loading icon template.
+     */
+    loadingicon(): TemplateRef<void>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<void>;
+}
+
+export type { TreeCheckboxIconTemplateContext, TreeFilterEvent, TreeFilterTemplateContext, TreeLazyLoadEvent, TreeLoaderTemplateContext, TreeLoadingMode, TreeNodeCollapseEvent, TreeNodeContextMenuSelectEvent, TreeNodeDoubleClickEvent, TreeNodeDropEvent, TreeNodeExpandEvent, TreeNodeSelectEvent, TreeNodeUnSelectEvent, TreePassThrough, TreePassThroughOptions, TreeScrollEvent, TreeScrollIndexChangeEvent, TreeSelectionMode, TreeTemplates, TreeTogglerIconTemplateContext };