@itwin/components-react 3.7.9 → 3.7.12

package/lib/esm/components-react/breadcrumb/BeInspireTree.d.ts

@@ -1,263 +1,263 @@
-/** @packageDocumentation
- * @module Tree
- */
-import * as Inspire from "inspire-tree";
-import { IDisposable } from "@itwin/core-bentley";
-import { CheckBoxInfo } from "@itwin/core-react";
-import { PageOptions } from "../common/PageOptions";
-/**
- * Enum containing all events that may be emitted by [[BeInspireTree]]
- * @internal
- */
-export declare enum BeInspireTreeEvent {
-    ChangesApplied = "changes.applied",
-    ChildrenLoaded = "children.loaded",
-    DataLoaded = "data.loaded",
-    DataLoadError = "data.loaderror",
-    ModelLoaded = "model.loaded",
-    NodeAdded = "node.added",
-    NodeBlurred = "node.blurred",
-    NodeChecked = "node.checked",
-    NodeCollapsed = "node.collapsed",
-    NodeDeselected = "node.deselected",
-    NodeEdited = "node.edited",
-    NodeExpanded = "node.expanded",
-    NodeFocused = "node.focused",
-    NodeHidden = "node.hidden",
-    NodeMoved = "node.moved",
-    NodePaginated = "node.paginated",
-    NodeRemoved = "node.removed",
-    NodeSelected = "node.selected",
-    NodeShown = "node.shown",
-    NodeUnchecked = "node.unchecked"
-}
-/** Be alias for Inspire.NodeConfig
- * @internal
- */
-export interface BeInspireTreeNodeConfig {
-    children?: BeInspireTreeNodeConfig[] | true;
-    id?: string;
-    text: string;
-    itree?: BeInspireTreeNodeITree;
-}
-/** Be alias for Inspire.NodeConfig.ITree
- * @internal
- */
-export interface BeInspireTreeNodeITree {
-    icon?: string;
-    checkboxTooltip?: string;
-    dirtyTimestamp?: number;
-    dirtyCounter?: number;
-    state?: {
-        checkboxVisible?: boolean;
-        checkboxDisabled?: boolean;
-        checked?: boolean;
-        collapsed?: boolean;
-        editable?: boolean;
-        focused?: boolean;
-        indeterminate?: boolean;
-        loading?: boolean;
-        selectable?: boolean;
-        selected?: boolean;
-    };
-}
-/** Data structure for [[BeInspireTreeNodeConfig]] with our injected props
- * @internal
- */
-export interface BeInspireTreeNodePayloadConfig<TPayload> extends BeInspireTreeNodeConfig {
-    /** Node's data. May be `undefined` if this is placeholder node. */
-    payload?: TPayload;
-    /** Index of the node at the parent level. Only set if this is a placeholder node. */
-    placeholderIndex?: number;
-    /** Reference to the tree */
-    beInspireTree: BeInspireTree<TPayload>;
-}
-/** Type definition for all BeInspireTree nodes
- * @internal
- */
-export interface BeInspireTreeNode<TPayload> extends Inspire.TreeNode, BeInspireTreeNodePayloadConfig<TPayload> {
-    isDirty(): boolean;
-    setDirty(value: boolean): void;
-    /** @internal */
-    resetBeInspireOverrides(): void;
-}
-/**
- * Definition of a list of [[BeInspireTreeNode]] with some additional filtering methods
- * @internal
- */
-export interface BeInspireTreeNodes<TPayload> extends Array<BeInspireTreeNode<TPayload>> {
-    node(id: string): BeInspireTreeNode<TPayload> | undefined;
-    nodes(ids?: string[]): BeInspireTreeNodes<TPayload>;
-    deepest(): BeInspireTreeNodes<TPayload>;
-    flatten(): BeInspireTreeNodes<TPayload>;
-    expanded(): BeInspireTreeNodes<TPayload>;
-    collapsed(): BeInspireTreeNodes<TPayload>;
-    selected(): BeInspireTreeNodes<TPayload>;
-    visible(): BeInspireTreeNodes<TPayload>;
-}
-/** Array of tree node data elements
- * @internal
- */
-export declare type BeInspireTreeDataProviderRaw<TPayload> = TPayload[];
-/** A Promise for DataProviderRaw
- * @internal
- */
-export declare type BeInspireTreeDataProviderPromise<TPayload> = Promise<BeInspireTreeDataProviderRaw<TPayload>>;
-/** Signature for BeInspireTree data provider
- * @internal
- */
-export declare type BeInspireTreeDataProviderMethod<TPayload> = (parent?: TPayload) => BeInspireTreeDataProviderPromise<TPayload>;
-/** Signature for BeInspireTree data provider
- * @internal
- */
-export interface BeInspireTreeDataProviderInterface<TPayload> {
-    getNodesCount(parent?: TPayload): Promise<number>;
-    getNodes(parent?: TPayload, page?: PageOptions): BeInspireTreeDataProviderPromise<TPayload>;
-}
-/** Type definition for all BeInspireTree data providers
- * @internal
- */
-export declare type BeInspireTreeDataProvider<TPayload> = BeInspireTreeDataProviderRaw<TPayload> | BeInspireTreeDataProviderPromise<TPayload> | BeInspireTreeDataProviderMethod<TPayload> | BeInspireTreeDataProviderInterface<TPayload>;
-/** Type definition for a BeInspireTree renderer
- * @internal
- */
-export declare type BeInspireTreeRenderer<TPayload> = (rootNodes: Array<BeInspireTreeNode<TPayload>>) => void;
-/**
- * A context which keeps [[BeInspireTree]] events muted until
- * it gets disposed.
- * @internal
- */
-export declare class EventsMuteContext implements IDisposable {
-    private _events;
-    private _mute;
-    private _unmute;
-    private _emit?;
-    private _listen?;
-    private _triggeredEventsCount;
-    private _didMute;
-    private _stopListening;
-    constructor(_events: BeInspireTreeEvent[], _mute: (events: BeInspireTreeEvent[]) => void, _unmute: (events: BeInspireTreeEvent[]) => boolean, _emit?: ((events: BeInspireTreeEvent[]) => void) | undefined, _listen?: ((events: BeInspireTreeEvent[], listener: (...values: any[]) => void) => (() => void)) | undefined, allowedEventTriggersBeforeMute?: number);
-    private init;
-    dispose(): void;
-}
-/** Prototype for BeInspireTreeProps.mapPayloadToInspireNodeConfig
- * @internal
- */
-export declare type MapPayloadToInspireNodeCallback<TPayload> = (payload: TPayload, remapper: MapPayloadToInspireNodeCallback<TPayload>) => BeInspireTreeNodeConfig;
-/**
- * Configuration properties for [[BeInspireTree]]
- * @internal
- */
-export interface BeInspireTreeProps<TNodePayload> {
-    dataProvider: BeInspireTreeDataProvider<TNodePayload>;
-    mapPayloadToInspireNodeConfig: MapPayloadToInspireNodeCallback<TNodePayload>;
-    pageSize?: number;
-    disposeChildrenOnCollapse?: boolean;
-}
-/**
- * Bentley wrapper for 'inspire-tree'
- * @internal
- */
-export declare class BeInspireTree<TNodePayload> {
-    private _tree;
-    private _eventMutes;
-    private _readyPromise;
-    private _deferredLoadingHandler?;
-    private _visibleCached?;
-    private _suspendedRendering?;
-    props: BeInspireTreeProps<TNodePayload>;
-    constructor(props: BeInspireTreeProps<TNodePayload>);
-    private onModelInvalidated;
-    get ready(): Promise<void>;
-    /**
-     * Stop emitting the specified events until the returned
-     * [[EventsMuteContext]] object is disposed
-     */
-    mute(events: BeInspireTreeEvent[]): EventsMuteContext;
-    private doMute;
-    private doUnmute;
-    private doEmit;
-    /**
-     * Stop calling the renderer method until the returned
-     * object is disposed. When that happens, the [[BeInspireTreeEvent.ChangesApplied]]
-     * event is emitted if any changes in the hierarchy happened during the pause
-     */
-    pauseRendering(allowedRendersBeforePause?: number): EventsMuteContext;
-    /**
-     * Request a new render of current model.
-     *
-     * @internal
-     */
-    applyChanges(): void;
-    /** Add a listener for specific event */
-    on(event: BeInspireTreeEvent | BeInspireTreeEvent[], listener: (...values: any[]) => void): this;
-    /** Remove listener for specific event */
-    removeListener(event: BeInspireTreeEvent | BeInspireTreeEvent[], listener: (...values: any[]) => void): this;
-    /** Remove all listeners for specific event(s) */
-    removeAllListeners(event?: BeInspireTreeEvent | BeInspireTreeEvent[]): void;
-    /** Get root node with the specified id */
-    node(id: string): BeInspireTreeNode<TNodePayload> | undefined;
-    /** Get root nodes with the specified ids */
-    nodes(ids?: string[]): BeInspireTreeNodes<TNodePayload>;
-    /** Get flat list of all available nodes */
-    flatten(): BeInspireTreeNodes<TNodePayload>;
-    /** Get a flat list of available leaf nodes */
-    deepest(): BeInspireTreeNodes<TNodePayload>;
-    /** Get a flat list of expanded nodes */
-    expanded(): BeInspireTreeNodes<TNodePayload>;
-    /** Get a flat list of collapsed nodes */
-    collapsed(): BeInspireTreeNodes<TNodePayload>;
-    /** Get a flat list of selected nodes */
-    selected(): BeInspireTreeNodes<TNodePayload>;
-    /** Get a flat list of visible nodes */
-    visible(): BeInspireTreeNodes<TNodePayload>;
-    /** Reload the tree */
-    reload(): Promise<void>;
-    /**
-     * Deselects all nodes
-     */
-    deselectAll(muteEvents?: boolean): void;
-    /**
-     * Returns all visible nodes that are located between the two input nodes (inclusive).
-     * Input nodes can be provided in any order.
-     */
-    getVisibleNodesBetween(node1: BeInspireTreeNode<TNodePayload>, node2: BeInspireTreeNode<TNodePayload>): Array<BeInspireTreeNode<TNodePayload>>;
-    /**
-     * Selects all visible nodes that are located between the two input nodes (inclusive).
-     * Input nodes can be provided in any order.
-     */
-    selectBetween(node1: BeInspireTreeNode<TNodePayload>, node2: BeInspireTreeNode<TNodePayload>, muteEvents?: boolean): Array<BeInspireTreeNode<TNodePayload>>;
-    private createSelectedNodePredicate;
-    private updateSelection;
-    /**
-     * Deselects everything and selects only nodes that meet the `nodesToSelect` criteria
-     */
-    updateTreeSelection(nodesToSelect?: string[] | ((payload: TNodePayload) => boolean), muteEvents?: boolean): void;
-    /**
-     * Updates selection state of provided `nodes` based on `nodesToSelect` criteria
-     */
-    updateNodesSelection(nodes: BeInspireTreeNodes<TNodePayload> | Inspire.TreeNodes, nodesToSelect?: string[] | ((payload: TNodePayload) => boolean), muteEvents?: boolean): void;
-    private updateNodeCheckboxInfo;
-    /**
-     * Updates checkbox states of the whole tree using the `checkboxInfo` callback function
-     */
-    updateTreeCheckboxes(checkboxInfo: ((payload: TNodePayload) => CheckBoxInfo | Promise<CheckBoxInfo>), muteEvents?: boolean): Promise<void>;
-    /**
-     * Updates checkbox states of provided `nodes` based on `checkboxInfo` callback function
-     */
-    updateNodesCheckboxes(nodes: BeInspireTreeNodes<TNodePayload>, checkboxInfo: ((payload: TNodePayload) => CheckBoxInfo | Promise<CheckBoxInfo>), muteEvents?: boolean): Promise<void>;
-    /** @internal */
-    createPlaceholderNode(index: number, parent?: BeInspireTreeNode<TNodePayload>): BeInspireTreeNode<TNodePayload>;
-    /**
-     * Request a node at the specified index to be loaded for the given parent. Only
-     * makes sense on a paginated tree, throws otherwise.
-     */
-    requestNodeLoad(parent: BeInspireTreeNode<TNodePayload> | undefined, index: number): Promise<void>;
-    /** @internal */
-    loadNodes(): Promise<void>;
-}
-/** @internal */
-export declare const toNode: <TPayload>(inspireNode: Inspire.TreeNode) => BeInspireTreeNode<TPayload>;
-/** @internal */
-export declare const toNodes: <TPayload>(inspireNodes: Inspire.TreeNodes) => BeInspireTreeNodes<TPayload>;
+/** @packageDocumentation
+ * @module Tree
+ */
+import * as Inspire from "inspire-tree";
+import { IDisposable } from "@itwin/core-bentley";
+import { CheckBoxInfo } from "@itwin/core-react";
+import { PageOptions } from "../common/PageOptions";
+/**
+ * Enum containing all events that may be emitted by [[BeInspireTree]]
+ * @internal
+ */
+export declare enum BeInspireTreeEvent {
+    ChangesApplied = "changes.applied",
+    ChildrenLoaded = "children.loaded",
+    DataLoaded = "data.loaded",
+    DataLoadError = "data.loaderror",
+    ModelLoaded = "model.loaded",
+    NodeAdded = "node.added",
+    NodeBlurred = "node.blurred",
+    NodeChecked = "node.checked",
+    NodeCollapsed = "node.collapsed",
+    NodeDeselected = "node.deselected",
+    NodeEdited = "node.edited",
+    NodeExpanded = "node.expanded",
+    NodeFocused = "node.focused",
+    NodeHidden = "node.hidden",
+    NodeMoved = "node.moved",
+    NodePaginated = "node.paginated",
+    NodeRemoved = "node.removed",
+    NodeSelected = "node.selected",
+    NodeShown = "node.shown",
+    NodeUnchecked = "node.unchecked"
+}
+/** Be alias for Inspire.NodeConfig
+ * @internal
+ */
+export interface BeInspireTreeNodeConfig {
+    children?: BeInspireTreeNodeConfig[] | true;
+    id?: string;
+    text: string;
+    itree?: BeInspireTreeNodeITree;
+}
+/** Be alias for Inspire.NodeConfig.ITree
+ * @internal
+ */
+export interface BeInspireTreeNodeITree {
+    icon?: string;
+    checkboxTooltip?: string;
+    dirtyTimestamp?: number;
+    dirtyCounter?: number;
+    state?: {
+        checkboxVisible?: boolean;
+        checkboxDisabled?: boolean;
+        checked?: boolean;
+        collapsed?: boolean;
+        editable?: boolean;
+        focused?: boolean;
+        indeterminate?: boolean;
+        loading?: boolean;
+        selectable?: boolean;
+        selected?: boolean;
+    };
+}
+/** Data structure for [[BeInspireTreeNodeConfig]] with our injected props
+ * @internal
+ */
+export interface BeInspireTreeNodePayloadConfig<TPayload> extends BeInspireTreeNodeConfig {
+    /** Node's data. May be `undefined` if this is placeholder node. */
+    payload?: TPayload;
+    /** Index of the node at the parent level. Only set if this is a placeholder node. */
+    placeholderIndex?: number;
+    /** Reference to the tree */
+    beInspireTree: BeInspireTree<TPayload>;
+}
+/** Type definition for all BeInspireTree nodes
+ * @internal
+ */
+export interface BeInspireTreeNode<TPayload> extends Inspire.TreeNode, BeInspireTreeNodePayloadConfig<TPayload> {
+    isDirty(): boolean;
+    setDirty(value: boolean): void;
+    /** @internal */
+    resetBeInspireOverrides(): void;
+}
+/**
+ * Definition of a list of [[BeInspireTreeNode]] with some additional filtering methods
+ * @internal
+ */
+export interface BeInspireTreeNodes<TPayload> extends Array<BeInspireTreeNode<TPayload>> {
+    node(id: string): BeInspireTreeNode<TPayload> | undefined;
+    nodes(ids?: string[]): BeInspireTreeNodes<TPayload>;
+    deepest(): BeInspireTreeNodes<TPayload>;
+    flatten(): BeInspireTreeNodes<TPayload>;
+    expanded(): BeInspireTreeNodes<TPayload>;
+    collapsed(): BeInspireTreeNodes<TPayload>;
+    selected(): BeInspireTreeNodes<TPayload>;
+    visible(): BeInspireTreeNodes<TPayload>;
+}
+/** Array of tree node data elements
+ * @internal
+ */
+export declare type BeInspireTreeDataProviderRaw<TPayload> = TPayload[];
+/** A Promise for DataProviderRaw
+ * @internal
+ */
+export declare type BeInspireTreeDataProviderPromise<TPayload> = Promise<BeInspireTreeDataProviderRaw<TPayload>>;
+/** Signature for BeInspireTree data provider
+ * @internal
+ */
+export declare type BeInspireTreeDataProviderMethod<TPayload> = (parent?: TPayload) => BeInspireTreeDataProviderPromise<TPayload>;
+/** Signature for BeInspireTree data provider
+ * @internal
+ */
+export interface BeInspireTreeDataProviderInterface<TPayload> {
+    getNodesCount(parent?: TPayload): Promise<number>;
+    getNodes(parent?: TPayload, page?: PageOptions): BeInspireTreeDataProviderPromise<TPayload>;
+}
+/** Type definition for all BeInspireTree data providers
+ * @internal
+ */
+export declare type BeInspireTreeDataProvider<TPayload> = BeInspireTreeDataProviderRaw<TPayload> | BeInspireTreeDataProviderPromise<TPayload> | BeInspireTreeDataProviderMethod<TPayload> | BeInspireTreeDataProviderInterface<TPayload>;
+/** Type definition for a BeInspireTree renderer
+ * @internal
+ */
+export declare type BeInspireTreeRenderer<TPayload> = (rootNodes: Array<BeInspireTreeNode<TPayload>>) => void;
+/**
+ * A context which keeps [[BeInspireTree]] events muted until
+ * it gets disposed.
+ * @internal
+ */
+export declare class EventsMuteContext implements IDisposable {
+    private _events;
+    private _mute;
+    private _unmute;
+    private _emit?;
+    private _listen?;
+    private _triggeredEventsCount;
+    private _didMute;
+    private _stopListening;
+    constructor(_events: BeInspireTreeEvent[], _mute: (events: BeInspireTreeEvent[]) => void, _unmute: (events: BeInspireTreeEvent[]) => boolean, _emit?: ((events: BeInspireTreeEvent[]) => void) | undefined, _listen?: ((events: BeInspireTreeEvent[], listener: (...values: any[]) => void) => (() => void)) | undefined, allowedEventTriggersBeforeMute?: number);
+    private init;
+    dispose(): void;
+}
+/** Prototype for BeInspireTreeProps.mapPayloadToInspireNodeConfig
+ * @internal
+ */
+export declare type MapPayloadToInspireNodeCallback<TPayload> = (payload: TPayload, remapper: MapPayloadToInspireNodeCallback<TPayload>) => BeInspireTreeNodeConfig;
+/**
+ * Configuration properties for [[BeInspireTree]]
+ * @internal
+ */
+export interface BeInspireTreeProps<TNodePayload> {
+    dataProvider: BeInspireTreeDataProvider<TNodePayload>;
+    mapPayloadToInspireNodeConfig: MapPayloadToInspireNodeCallback<TNodePayload>;
+    pageSize?: number;
+    disposeChildrenOnCollapse?: boolean;
+}
+/**
+ * Bentley wrapper for 'inspire-tree'
+ * @internal
+ */
+export declare class BeInspireTree<TNodePayload> {
+    private _tree;
+    private _eventMutes;
+    private _readyPromise;
+    private _deferredLoadingHandler?;
+    private _visibleCached?;
+    private _suspendedRendering?;
+    props: BeInspireTreeProps<TNodePayload>;
+    constructor(props: BeInspireTreeProps<TNodePayload>);
+    private onModelInvalidated;
+    get ready(): Promise<void>;
+    /**
+     * Stop emitting the specified events until the returned
+     * [[EventsMuteContext]] object is disposed
+     */
+    mute(events: BeInspireTreeEvent[]): EventsMuteContext;
+    private doMute;
+    private doUnmute;
+    private doEmit;
+    /**
+     * Stop calling the renderer method until the returned
+     * object is disposed. When that happens, the [[BeInspireTreeEvent.ChangesApplied]]
+     * event is emitted if any changes in the hierarchy happened during the pause
+     */
+    pauseRendering(allowedRendersBeforePause?: number): EventsMuteContext;
+    /**
+     * Request a new render of current model.
+     *
+     * @internal
+     */
+    applyChanges(): void;
+    /** Add a listener for specific event */
+    on(event: BeInspireTreeEvent | BeInspireTreeEvent[], listener: (...values: any[]) => void): this;
+    /** Remove listener for specific event */
+    removeListener(event: BeInspireTreeEvent | BeInspireTreeEvent[], listener: (...values: any[]) => void): this;
+    /** Remove all listeners for specific event(s) */
+    removeAllListeners(event?: BeInspireTreeEvent | BeInspireTreeEvent[]): void;
+    /** Get root node with the specified id */
+    node(id: string): BeInspireTreeNode<TNodePayload> | undefined;
+    /** Get root nodes with the specified ids */
+    nodes(ids?: string[]): BeInspireTreeNodes<TNodePayload>;
+    /** Get flat list of all available nodes */
+    flatten(): BeInspireTreeNodes<TNodePayload>;
+    /** Get a flat list of available leaf nodes */
+    deepest(): BeInspireTreeNodes<TNodePayload>;
+    /** Get a flat list of expanded nodes */
+    expanded(): BeInspireTreeNodes<TNodePayload>;
+    /** Get a flat list of collapsed nodes */
+    collapsed(): BeInspireTreeNodes<TNodePayload>;
+    /** Get a flat list of selected nodes */
+    selected(): BeInspireTreeNodes<TNodePayload>;
+    /** Get a flat list of visible nodes */
+    visible(): BeInspireTreeNodes<TNodePayload>;
+    /** Reload the tree */
+    reload(): Promise<void>;
+    /**
+     * Deselects all nodes
+     */
+    deselectAll(muteEvents?: boolean): void;
+    /**
+     * Returns all visible nodes that are located between the two input nodes (inclusive).
+     * Input nodes can be provided in any order.
+     */
+    getVisibleNodesBetween(node1: BeInspireTreeNode<TNodePayload>, node2: BeInspireTreeNode<TNodePayload>): Array<BeInspireTreeNode<TNodePayload>>;
+    /**
+     * Selects all visible nodes that are located between the two input nodes (inclusive).
+     * Input nodes can be provided in any order.
+     */
+    selectBetween(node1: BeInspireTreeNode<TNodePayload>, node2: BeInspireTreeNode<TNodePayload>, muteEvents?: boolean): Array<BeInspireTreeNode<TNodePayload>>;
+    private createSelectedNodePredicate;
+    private updateSelection;
+    /**
+     * Deselects everything and selects only nodes that meet the `nodesToSelect` criteria
+     */
+    updateTreeSelection(nodesToSelect?: string[] | ((payload: TNodePayload) => boolean), muteEvents?: boolean): void;
+    /**
+     * Updates selection state of provided `nodes` based on `nodesToSelect` criteria
+     */
+    updateNodesSelection(nodes: BeInspireTreeNodes<TNodePayload> | Inspire.TreeNodes, nodesToSelect?: string[] | ((payload: TNodePayload) => boolean), muteEvents?: boolean): void;
+    private updateNodeCheckboxInfo;
+    /**
+     * Updates checkbox states of the whole tree using the `checkboxInfo` callback function
+     */
+    updateTreeCheckboxes(checkboxInfo: ((payload: TNodePayload) => CheckBoxInfo | Promise<CheckBoxInfo>), muteEvents?: boolean): Promise<void>;
+    /**
+     * Updates checkbox states of provided `nodes` based on `checkboxInfo` callback function
+     */
+    updateNodesCheckboxes(nodes: BeInspireTreeNodes<TNodePayload>, checkboxInfo: ((payload: TNodePayload) => CheckBoxInfo | Promise<CheckBoxInfo>), muteEvents?: boolean): Promise<void>;
+    /** @internal */
+    createPlaceholderNode(index: number, parent?: BeInspireTreeNode<TNodePayload>): BeInspireTreeNode<TNodePayload>;
+    /**
+     * Request a node at the specified index to be loaded for the given parent. Only
+     * makes sense on a paginated tree, throws otherwise.
+     */
+    requestNodeLoad(parent: BeInspireTreeNode<TNodePayload> | undefined, index: number): Promise<void>;
+    /** @internal */
+    loadNodes(): Promise<void>;
+}
+/** @internal */
+export declare const toNode: <TPayload>(inspireNode: Inspire.TreeNode) => BeInspireTreeNode<TPayload>;
+/** @internal */
+export declare const toNodes: <TPayload>(inspireNodes: Inspire.TreeNodes) => BeInspireTreeNodes<TPayload>;
 //# sourceMappingURL=BeInspireTree.d.ts.map