@gravionlabs/helix-core 22.1.1 → 22.1.3

package/types/gravionlabs-helix-core-types-tree.d.ts

@@ -1,11 +1,10 @@
-import { TemplateRef } from '@angular/core';
-import { TreeNode, ScrollerOptions, PassThrough, PassThroughOption } from '@gravionlabs/helix-core/api';
-import { CheckboxPassThrough } from '@gravionlabs/helix-core/types/checkbox';
-import { IconFieldPassThrough } from '@gravionlabs/helix-core/types/iconfield';
-import { InputIconPassThrough } from '@gravionlabs/helix-core/types/inputicon';
-import { InputTextPassThrough } from '@gravionlabs/helix-core/types/inputtext';
-import { VirtualScrollerPassThrough } from '@gravionlabs/helix-core/types/scroller';
-
+import { TemplateRef } from "@angular/core";
+import { PassThrough, PassThroughOption, ScrollerOptions, TreeNode } from "@gravionlabs/helix-core/api";
+import { CheckboxPassThrough } from "@gravionlabs/helix-core/types/checkbox";
+import { IconFieldPassThrough } from "@gravionlabs/helix-core/types/iconfield";
+import { InputIconPassThrough } from "@gravionlabs/helix-core/types/inputicon";
+import { InputTextPassThrough } from "@gravionlabs/helix-core/types/inputtext";
+import { VirtualScrollerPassThrough } from "@gravionlabs/helix-core/types/scroller";
 /**
  * Custom pass-through(pt) options.
  * @template I Type of instance.
@@ -13,91 +12,91 @@ import { VirtualScrollerPassThrough } from '@gravionlabs/helix-core/types/scroll
  * @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>;
+export 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.
@@ -105,21 +104,21 @@ interface TreePassThroughOptions<I = unknown> {
  *
  * @template I Type of instance.
  */
-type TreePassThrough<I = unknown> = PassThrough<I, TreePassThroughOptions<I>>;
+export 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>;
+export interface TreeNodeSelectEvent {
+  /**
+   * Browser event
+   */
+  originalEvent: Event;
+  /**
+   * Node instance.
+   */
+  node: TreeNode<any>;
 }
 /**
  * Custom node unselect event.
@@ -127,216 +126,208 @@ interface TreeNodeSelectEvent {
  * @extends {TreeNodeSelectEvent}
  * @group Events
  */
-interface TreeNodeUnSelectEvent extends TreeNodeSelectEvent {
-}
+export interface TreeNodeUnSelectEvent extends TreeNodeSelectEvent {}
 /**
  * Custom node expand event.
  * @see {@link Tree.onNodeExpand}
  * @extends {TreeNodeSelectEvent}
  * @group Events
  */
-interface TreeNodeExpandEvent extends TreeNodeSelectEvent {
-}
+export interface TreeNodeExpandEvent extends TreeNodeSelectEvent {}
 /**
  * Custom node collapse event.
  * @see {@link Tree.onNodeCollapse}
  * @extends {TreeNodeSelectEvent}
  * @group Events
  */
-interface TreeNodeCollapseEvent extends TreeNodeSelectEvent {
-}
+export interface TreeNodeCollapseEvent extends TreeNodeSelectEvent {}
 /**
  * Custom context menu select event.
  * @see {@link Tree.onNodeContextMenuSelect}
  * @extends {TreeNodeSelectEvent}
  * @group Events
  */
-interface TreeNodeContextMenuSelectEvent extends TreeNodeSelectEvent {
-}
+export interface TreeNodeContextMenuSelectEvent extends TreeNodeSelectEvent {}
 /**
  * Custom node double click event.
  * @see {@link Tree.onNodeDoubleClick}
  * @extends {TreeNodeSelectEvent}
  * @group Events
  */
-interface TreeNodeDoubleClickEvent extends TreeNodeSelectEvent {
-}
+export 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;
-    /**
-     * Callback to invoke on drop.
-     */
-    accept?: Function;
+export 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;
+  /**
+   * 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;
+export 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 {
-}
+export interface TreeScrollIndexChangeEvent extends TreeLazyLoadEvent {}
 /**
  * Custom scroll event.
  * @see {@link Tree.onScroll}
  * @group Events
  */
-interface TreeScrollEvent {
-    /**
-     * Browser event.
-     */
-    originalEvent?: Event;
+export 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;
+export 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;
-    };
+export 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;
+export 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;
+export 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;
+export 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, TreeNodeCollapseEvent, TreeNodeContextMenuSelectEvent, TreeNodeDoubleClickEvent, TreeNodeDropEvent, TreeNodeExpandEvent, TreeNodeSelectEvent, TreeNodeUnSelectEvent, TreePassThrough, TreePassThroughOptions, TreeScrollEvent, TreeScrollIndexChangeEvent, TreeTemplates, TreeTogglerIconTemplateContext };
+export 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>;
+}