@itwin/presentation-hierarchies-react 2.0.0-alpha.4 → 2.0.0-alpha.40

package/lib/esm/presentation-hierarchies-react/stratakit/FilterAction.js

@@ -0,0 +1,26 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { memo, useCallback } from "react";
+import filterSvg from "@stratakit/icons/filter.svg";
+import { Tree } from "@stratakit/structures";
+import { useLocalizationContext } from "./LocalizationContext.js";
+/**
+ * React component that renders a filter action for a tree item.
+ * @alpha
+ */
+export const FilterAction = memo(function FilterAction({ node, onFilter, getHierarchyLevelDetails, reserveSpace, }) {
+    const { localizedStrings } = useLocalizationContext();
+    const { filterHierarchyLevel, filterHierarchyLevelActiveDescription } = localizedStrings;
+    const handleClick = useCallback(() => {
+        const hierarchyLevelDetails = getHierarchyLevelDetails?.(node.id);
+        hierarchyLevelDetails && onFilter?.(hierarchyLevelDetails);
+    }, [node, getHierarchyLevelDetails, onFilter]);
+    if (!onFilter || !node.isFilterable) {
+        return reserveSpace ? _jsx(Tree.ItemAction, { label: filterHierarchyLevel, icon: filterSvg, visible: false, disabled: true }) : undefined;
+    }
+    return (_jsx(Tree.ItemAction, { label: filterHierarchyLevel, onClick: handleClick, icon: filterSvg, visible: node.isFiltered ? true : undefined, dot: node.isFiltered ? filterHierarchyLevelActiveDescription : undefined }));
+});
+//# sourceMappingURL=FilterAction.js.map

package/lib/esm/presentation-hierarchies-react/stratakit/FilterAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilterAction.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/FilterAction.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,SAAS,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAG7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAgBlE;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,YAAY,CAAC,EACrD,IAAI,EACJ,QAAQ,EACR,wBAAwB,EACxB,YAAY,GAC4C;IACxD,MAAM,EAAE,gBAAgB,EAAE,GAAG,sBAAsB,EAAE,CAAC;IACtD,MAAM,EAAE,oBAAoB,EAAE,qCAAqC,EAAE,GAAG,gBAAgB,CAAC;IAEzF,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACnC,MAAM,qBAAqB,GAAG,wBAAwB,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClE,qBAAqB,IAAI,QAAQ,EAAE,CAAC,qBAAqB,CAAC,CAAC;IAC7D,CAAC,EAAE,CAAC,IAAI,EAAE,wBAAwB,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE/C,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,OAAO,YAAY,CAAC,CAAC,CAAC,KAAC,IAAI,CAAC,UAAU,IAAC,KAAK,EAAE,oBAAoB,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,SAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/H,CAAC;IAED,OAAO,CACL,KAAC,IAAI,CAAC,UAAU,IACd,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,WAAW,EACpB,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAC3C,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,qCAAqC,CAAC,CAAC,CAAC,SAAS,GACxE,CACH,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { memo, useCallback } from \"react\";\nimport filterSvg from \"@stratakit/icons/filter.svg\";\nimport { Tree } from \"@stratakit/structures\";\nimport { HierarchyLevelDetails, TreeRendererProps } from \"../Renderers.js\";\nimport { PresentationHierarchyNode } from \"../TreeNode.js\";\nimport { useLocalizationContext } from \"./LocalizationContext.js\";\n\n/** @alpha */\nexport type FilterActionProps = {\n  /** Action to perform when the filter button is clicked for this node. */\n  onFilter?: (hierarchyLevelDetails: HierarchyLevelDetails) => void;\n  /**\n   * Indicates that space for this action button should be reserved, even when the action is not available.\n   * For nodes that don't support filtering, `<FilterAction reserveSpace />` renders:\n   *\n   * - Blank space when the action is used as an inline action. It's recommended to set this prop to keep all action buttons of the same kind vertically aligned.\n   * - Disabled menu item when the action is used as a menu action.\n   */\n  reserveSpace?: true;\n} & Pick<TreeRendererProps, \"getHierarchyLevelDetails\">;\n\n/**\n * React component that renders a filter action for a tree item.\n * @alpha\n */\nexport const FilterAction = memo(function FilterAction({\n  node,\n  onFilter,\n  getHierarchyLevelDetails,\n  reserveSpace,\n}: FilterActionProps & { node: PresentationHierarchyNode }) {\n  const { localizedStrings } = useLocalizationContext();\n  const { filterHierarchyLevel, filterHierarchyLevelActiveDescription } = localizedStrings;\n\n  const handleClick = useCallback(() => {\n    const hierarchyLevelDetails = getHierarchyLevelDetails?.(node.id);\n    hierarchyLevelDetails && onFilter?.(hierarchyLevelDetails);\n  }, [node, getHierarchyLevelDetails, onFilter]);\n\n  if (!onFilter || !node.isFilterable) {\n    return reserveSpace ? <Tree.ItemAction label={filterHierarchyLevel} icon={filterSvg} visible={false} disabled /> : undefined;\n  }\n\n  return (\n    <Tree.ItemAction\n      label={filterHierarchyLevel}\n      onClick={handleClick}\n      icon={filterSvg}\n      visible={node.isFiltered ? true : undefined}\n      dot={node.isFiltered ? filterHierarchyLevelActiveDescription : undefined}\n    />\n  );\n});\n"]}

package/lib/esm/presentation-hierarchies-react/stratakit/FlatTreeNode.d.ts

@@ -0,0 +1,58 @@
+import { PresentationHierarchyNode } from "../TreeNode.js";
+/**
+ * Placeholder item that is added to hierarchy as a child for a parent item while its child items are loading.
+ *
+ * @alpha
+ * */
+interface FlatPlaceholderItem {
+    id: string;
+    level: number;
+    placeholder: true;
+}
+/**
+ * An item containing `PresentationHierarchyNode` node with properties needed for a flat tree structure.
+ *
+ * @alpha
+ */
+export interface FlatTreeNodeItem {
+    id: string;
+    level: number;
+    levelSize: number;
+    posInLevel: number;
+    node: PresentationHierarchyNode;
+}
+/**
+ * An item used to build an error message.
+ * Returned by `useErrorList`.
+ *
+ * @alpha
+ * */
+export interface ErrorItem {
+    errorNode: PresentationHierarchyNode & Pick<Required<PresentationHierarchyNode>, "error">;
+    expandTo: (expandNode: (nodeId: string) => void) => void;
+}
+/**
+ * An Item describing single tree item position and its content inside tree.
+ * Returned by `useFlatTreeNodeList` hook.
+ *
+ *  @alpha
+ */
+export type FlatTreeItem = FlatTreeNodeItem | FlatPlaceholderItem;
+/** @alpha */
+export declare function isPlaceholderItem(item: FlatTreeItem): item is FlatPlaceholderItem;
+/**
+ * Used to get a list of `FlatTreeItem` objects for the given list of `PresentationHierarchyNode` objects that represent
+ * a hierarchical structure. The resulting items can be used to render the hierarchy in a flat manner, e.g. using a
+ * virtualized list.
+ *
+ * @alpha
+ */
+export declare function useFlatTreeItems(rootNodes: PresentationHierarchyNode[]): FlatTreeItem[];
+/**
+ * Finds and returns all items containing errors in a given hierarchy in the form of `ErrorItem[]`.
+ *
+ * @alpha
+ */
+export declare function useErrorList(rootNodes: PresentationHierarchyNode[]): ErrorItem[];
+export {};
+//# sourceMappingURL=FlatTreeNode.d.ts.map

package/lib/esm/presentation-hierarchies-react/stratakit/FlatTreeNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlatTreeNode.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/FlatTreeNode.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAE3D;;;;KAIK;AACL,UAAU,mBAAmB;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,IAAI,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED;;;;;KAKK;AACL,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,yBAAyB,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1F,QAAQ,EAAE,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAC;CAC1D;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;AAElE,aAAa;AACb,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,IAAI,mBAAmB,CAEjF;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,yBAAyB,EAAE,kBAEtE;AAoBD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,yBAAyB,EAAE,GAAG,SAAS,EAAE,CAchF"}

package/lib/esm/presentation-hierarchies-react/stratakit/FlatTreeNode.js

@@ -0,0 +1,77 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { useMemo } from "react";
+/** @alpha */
+export function isPlaceholderItem(item) {
+    return "placeholder" in item;
+}
+/**
+ * Used to get a list of `FlatTreeItem` objects for the given list of `PresentationHierarchyNode` objects that represent
+ * a hierarchical structure. The resulting items can be used to render the hierarchy in a flat manner, e.g. using a
+ * virtualized list.
+ *
+ * @alpha
+ */
+export function useFlatTreeItems(rootNodes) {
+    return useMemo(() => getFlatItems(rootNodes, 1), [rootNodes]);
+}
+function getFlatItems(nodes, level) {
+    const flatItems = [];
+    nodes.forEach((node, index) => {
+        flatItems.push({ node, id: node.id, level, levelSize: nodes.length, posInLevel: index + 1 });
+        if (!node.isExpanded || node.error) {
+            return;
+        }
+        if (node.children !== true) {
+            const childNodes = getFlatItems(node.children, level + 1);
+            flatItems.push(...childNodes);
+            return;
+        }
+        flatItems.push({ id: `${node.id}-children-placeholder`, level: level + 1, placeholder: true });
+    });
+    return flatItems;
+}
+/**
+ * Finds and returns all items containing errors in a given hierarchy in the form of `ErrorItem[]`.
+ *
+ * @alpha
+ */
+export function useErrorList(rootNodes) {
+    return useMemo(() => rootNodes.flatMap((rootNode) => {
+        if (isErrorNode(rootNode)) {
+            return [{ errorNode: rootNode, expandTo: (expandNode) => expandTo(expandNode, []) }];
+        }
+        if (rootNode.children === true) {
+            return [];
+        }
+        return getErrorItems(rootNode, !rootNode.isExpanded ? [rootNode.id] : []);
+    }), [rootNodes]);
+}
+function getErrorItems(parent, path) {
+    const errorList = [];
+    if (parent.children === true) {
+        return [];
+    }
+    const pathToChild = [...path, ...(!parent.isExpanded ? [parent.id] : [])];
+    parent.children.forEach((node) => {
+        if (isErrorNode(node)) {
+            errorList.push({ errorNode: node, expandTo: (expandNode) => expandTo(expandNode, path) });
+            return;
+        }
+        if (node.children !== true) {
+            const childErrorList = getErrorItems(node, pathToChild);
+            errorList.push(...childErrorList);
+            return;
+        }
+    });
+    return errorList;
+}
+function expandTo(expandNode, path) {
+    path.forEach((nodeId) => expandNode(nodeId));
+}
+function isErrorNode(node) {
+    return node.error !== undefined;
+}
+//# sourceMappingURL=FlatTreeNode.js.map

package/lib/esm/presentation-hierarchies-react/stratakit/FlatTreeNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlatTreeNode.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/FlatTreeNode.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AA8ChC,aAAa;AACb,MAAM,UAAU,iBAAiB,CAAC,IAAkB;IAClD,OAAO,aAAa,IAAI,IAAI,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAsC;IACrE,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,YAAY,CAAC,KAAkC,EAAE,KAAa;IACrE,MAAM,SAAS,GAAmB,EAAE,CAAC;IACrC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACnC,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YAC1D,SAAS,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;YAC9B,OAAO;QACT,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,EAAE,uBAAuB,EAAE,KAAK,EAAE,KAAK,GAAG,CAAC,EAAE,WAAW,EAAE,IAAI,EAAgC,CAAC,CAAC;IAC/H,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,SAAsC;IACjE,OAAO,OAAO,CACZ,GAAG,EAAE,CACH,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,IAAI,QAAQ,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC/B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,aAAa,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,EACJ,CAAC,SAAS,CAAC,CACZ,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,MAAiC,EAAE,IAAc;IACtE,MAAM,SAAS,GAAgB,EAAE,CAAC;IAElC,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC7B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1E,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/B,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,SAAS,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1F,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YAC3B,MAAM,cAAc,GAAG,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACxD,SAAS,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;YAClC,OAAO;QACT,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,QAAQ,CAAC,UAAoC,EAAE,IAAc;IACpE,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,WAAW,CAAC,IAA+B;IAClD,OAAO,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC;AAClC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { useMemo } from \"react\";\nimport { PresentationHierarchyNode } from \"../TreeNode.js\";\n\n/**\n * Placeholder item that is added to hierarchy as a child for a parent item while its child items are loading.\n *\n * @alpha\n * */\ninterface FlatPlaceholderItem {\n  id: string;\n  level: number;\n  placeholder: true;\n}\n\n/**\n * An item containing `PresentationHierarchyNode` node with properties needed for a flat tree structure.\n *\n * @alpha\n */\nexport interface FlatTreeNodeItem {\n  id: string;\n  level: number;\n  levelSize: number;\n  posInLevel: number;\n  node: PresentationHierarchyNode;\n}\n\n/**\n * An item used to build an error message.\n * Returned by `useErrorList`.\n *\n * @alpha\n * */\nexport interface ErrorItem {\n  errorNode: PresentationHierarchyNode & Pick<Required<PresentationHierarchyNode>, \"error\">;\n  expandTo: (expandNode: (nodeId: string) => void) => void;\n}\n\n/**\n * An Item describing single tree item position and its content inside tree.\n * Returned by `useFlatTreeNodeList` hook.\n *\n *  @alpha\n */\nexport type FlatTreeItem = FlatTreeNodeItem | FlatPlaceholderItem;\n\n/** @alpha */\nexport function isPlaceholderItem(item: FlatTreeItem): item is FlatPlaceholderItem {\n  return \"placeholder\" in item;\n}\n\n/**\n * Used to get a list of `FlatTreeItem` objects for the given list of `PresentationHierarchyNode` objects that represent\n * a hierarchical structure. The resulting items can be used to render the hierarchy in a flat manner, e.g. using a\n * virtualized list.\n *\n * @alpha\n */\nexport function useFlatTreeItems(rootNodes: PresentationHierarchyNode[]) {\n  return useMemo(() => getFlatItems(rootNodes, 1), [rootNodes]);\n}\n\nfunction getFlatItems(nodes: PresentationHierarchyNode[], level: number) {\n  const flatItems: FlatTreeItem[] = [];\n  nodes.forEach((node, index) => {\n    flatItems.push({ node, id: node.id, level, levelSize: nodes.length, posInLevel: index + 1 });\n    if (!node.isExpanded || node.error) {\n      return;\n    }\n    if (node.children !== true) {\n      const childNodes = getFlatItems(node.children, level + 1);\n      flatItems.push(...childNodes);\n      return;\n    }\n\n    flatItems.push({ id: `${node.id}-children-placeholder`, level: level + 1, placeholder: true } satisfies FlatPlaceholderItem);\n  });\n  return flatItems;\n}\n\n/**\n * Finds and returns all items containing errors in a given hierarchy in the form of `ErrorItem[]`.\n *\n * @alpha\n */\nexport function useErrorList(rootNodes: PresentationHierarchyNode[]): ErrorItem[] {\n  return useMemo(\n    () =>\n      rootNodes.flatMap((rootNode) => {\n        if (isErrorNode(rootNode)) {\n          return [{ errorNode: rootNode, expandTo: (expandNode) => expandTo(expandNode, []) }];\n        }\n        if (rootNode.children === true) {\n          return [];\n        }\n        return getErrorItems(rootNode, !rootNode.isExpanded ? [rootNode.id] : []);\n      }),\n    [rootNodes],\n  );\n}\n\nfunction getErrorItems(parent: PresentationHierarchyNode, path: string[]) {\n  const errorList: ErrorItem[] = [];\n\n  if (parent.children === true) {\n    return [];\n  }\n\n  const pathToChild = [...path, ...(!parent.isExpanded ? [parent.id] : [])];\n  parent.children.forEach((node) => {\n    if (isErrorNode(node)) {\n      errorList.push({ errorNode: node, expandTo: (expandNode) => expandTo(expandNode, path) });\n      return;\n    }\n\n    if (node.children !== true) {\n      const childErrorList = getErrorItems(node, pathToChild);\n      errorList.push(...childErrorList);\n      return;\n    }\n  });\n  return errorList;\n}\n\nfunction expandTo(expandNode: (nodeId: string) => void, path: string[]) {\n  path.forEach((nodeId) => expandNode(nodeId));\n}\n\nfunction isErrorNode(node: PresentationHierarchyNode): node is PresentationHierarchyNode & Pick<Required<PresentationHierarchyNode>, \"error\"> {\n  return node.error !== undefined;\n}\n"]}

package/lib/esm/presentation-hierarchies-react/stratakit/LocalizationContext.d.ts

@@ -0,0 +1,123 @@
+import { PropsWithChildren } from "react";
+/**
+ * Localized strings used in the components.
+ * @public
+ */
+export interface LocalizedStrings {
+    /**
+     * Message displayed when nodes are loading.
+     * Default value: `Loading...`.
+     */
+    loading: string;
+    /**
+     * Title for apply hierarchy filter button.
+     * Default value: `Apply filter`.
+     */
+    filterHierarchyLevel: string;
+    /**
+     * Accessible description for applied hierarchy filter button.
+     * Default value: `Filter is applied`.
+     */
+    filterHierarchyLevelActiveDescription: string;
+    /**
+     * Title for clear hierarchy filter button.
+     * Default value: `Clear active filter`.
+     */
+    clearHierarchyLevelFilter: string;
+    /**
+     * Message displayed when no nodes matching filter are found.
+     * Default value: `No matches for current filter for {{node}}.`.
+     */
+    noFilteredChildren: string;
+    /**
+     * Label for change filter action.
+     * Default value: `Change filter`.
+     */
+    noFilteredChildrenChangeFilter: string;
+    /**
+     * Message displayed when hierarchy creation for a node failed.
+     * Default value: `Failed to create hierarchy for {{node}}.`.
+     */
+    failedToCreateHierarchy: string;
+    /**
+     * Message displayed when hierarchy creation for a node failed.
+     * Default value: `Failed to load tree.`.
+     */
+    failedToCreateRootHierarchy: string;
+    /**
+     * Message displayed when result limit exceeds hierarchy size limit.
+     * Default value: `The hierarchy for {{node}} contains {{limit}}+ items. Try using filters or increase the limit.`.
+     */
+    resultLimitExceeded: string;
+    /**
+     * Message displayed when result limit exceeds hierarchy size limit.
+     * Default value: `The root item hierarchy contains {{limit}}+ items. Try increasing the limit.`.
+     */
+    rootResultLimitExceeded: string;
+    /**
+     * Name for the error region landmark.
+     * Default value: `Issues for {{tree_label}}.`.
+     */
+    issuesForTree: string;
+    /**
+     * Label displayed on the error region, when errors are detected.
+     * Default value: `{{number_of_issues}} issue(s) found.`.
+     */
+    issuesFound: string;
+    /**
+     * Label displayed on the error region, when no issues are found.
+     * Default value: `No issues found.`.
+     */
+    noIssuesFound: string;
+    /**
+     * Message displayed when hierarchy size limit can be overridden.
+     * Default value: `Increase limit to {{limit}}`.
+     */
+    increaseHierarchyLimit: string;
+    /**
+     * Message displayed when hierarchy size limit can be overridden.
+     * Default value: `Remove limit`.
+     */
+    increaseHierarchyLimitToUnlimited: string;
+    /**
+     * Message displayed when hierarchy size limit can be overridden and hierarchy filtering is enabled.
+     * Default value: `Add Filter`.
+     */
+    increaseHierarchyLimitWithFiltering: string;
+    /**
+     * Label for retry action.
+     * Default value: `Retry`.
+     */
+    retry: string;
+    /**
+     * Label for rename action.
+     * Default value: `Rename`.
+     */
+    rename: string;
+    /**
+     * Label for more actions button.
+     * Default value: `More`.
+     */
+    more: string;
+}
+/** @internal */
+export interface LocalizationContext {
+    localizedStrings: LocalizedStrings;
+}
+/**
+ * Properties for `LocalizationContextProvider`.
+ * @public
+ */
+interface LocalizationContextProviderProps {
+    /** Localized strings used in the components. */
+    localizedStrings?: Partial<LocalizedStrings>;
+}
+/**
+ * Context provider for localized strings used in the components.
+ * @public
+ */
+export declare function LocalizationContextProvider({ localizedStrings, children }: PropsWithChildren<LocalizationContextProviderProps>): import("react/jsx-runtime").JSX.Element;
+/** @internal */
+export declare function useLocalizationContext(): LocalizationContext;
+export {};
+//# sourceMappingURL=LocalizationContext.d.ts.map

package/lib/esm/presentation-hierarchies-react/stratakit/LocalizationContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalizationContext.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/LocalizationContext.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAiB,iBAAiB,EAAmC,MAAM,OAAO,CAAC;AAE1F;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,qCAAqC,EAAE,MAAM,CAAC;IAC9C;;;OAGG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,8BAA8B,EAAE,MAAM,CAAC;IACvC;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,iCAAiC,EAAE,MAAM,CAAC;IAC1C;;;OAGG;IACH,mCAAmC,EAAE,MAAM,CAAC;IAC5C;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AA0BD;;;GAGG;AACH,UAAU,gCAAgC;IACxC,gDAAgD;IAChD,gBAAgB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC9C;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,EAAE,gBAAgB,EAAE,QAAQ,EAAE,EAAE,iBAAiB,CAAC,gCAAgC,CAAC,2CAQ9H;AAED,gBAAgB;AAChB,wBAAgB,sBAAsB,wBAErC"}

package/lib/esm/presentation-hierarchies-react/{itwinui → stratakit}/LocalizationContext.js

@@ -7,13 +7,23 @@ import { createContext, useContext, useEffect, useState } from "react";
 const defaultLocalizedStrings = {
     loading: "Loading...",
     filterHierarchyLevel: "Apply filter",
+    filterHierarchyLevelActiveDescription: "Filter is applied",
     clearHierarchyLevelFilter: "Clear active filter",
-    noFilteredChildren: "No child nodes match current filter",
-    resultLimitExceeded: "There are more items than allowed limit of {{limit}}.",
-    resultLimitExceededWithFiltering: "Please provide <link>additional filtering</link> - there are more items than allowed limit of {{limit}}.",
-    increaseHierarchyLimit: "<link>Increase the hierarchy level size limit to {{limit}}.</link>",
-    increaseHierarchyLimitWithFiltering: "Or, <link>increase the hierarchy level size limit to {{limit}}.</link>",
+    noFilteredChildren: "No matches for current filter for {{node}}.",
+    noFilteredChildrenChangeFilter: "Change filter",
+    failedToCreateHierarchy: "Failed to create hierarchy for {{node}}.",
+    failedToCreateRootHierarchy: "Failed to load tree.",
+    resultLimitExceeded: "The hierarchy for {{node}} contains {{limit}}+ items. Try using filters or increase the limit.",
+    rootResultLimitExceeded: "The root item hierarchy contains {{limit}}+ items. Try increasing the limit.",
+    issuesForTree: "Issues for {{tree_label}}.",
+    issuesFound: "{{number_of_issues}} issue(s) found.",
+    noIssuesFound: "No issues found.",
+    increaseHierarchyLimit: "Increase limit to {{limit}}",
+    increaseHierarchyLimitToUnlimited: "Remove limit",
+    increaseHierarchyLimitWithFiltering: "Add Filter",
     retry: "Retry",
+    rename: "Rename",
+    more: "More",
 };
 const localizationContext = createContext({ localizedStrings: defaultLocalizedStrings });
 /**

package/lib/esm/presentation-hierarchies-react/stratakit/LocalizationContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalizationContext.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/LocalizationContext.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAqB,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA6G1F,MAAM,uBAAuB,GAAqB;IAChD,OAAO,EAAE,YAAY;IACrB,oBAAoB,EAAE,cAAc;IACpC,qCAAqC,EAAE,mBAAmB;IAC1D,yBAAyB,EAAE,qBAAqB;IAChD,kBAAkB,EAAE,6CAA6C;IACjE,8BAA8B,EAAE,eAAe;IAC/C,uBAAuB,EAAE,0CAA0C;IACnE,2BAA2B,EAAE,sBAAsB;IACnD,mBAAmB,EAAE,gGAAgG;IACrH,uBAAuB,EAAE,8EAA8E;IACvG,aAAa,EAAE,4BAA4B;IAC3C,WAAW,EAAE,sCAAsC;IACnD,aAAa,EAAE,kBAAkB;IACjC,sBAAsB,EAAE,6BAA6B;IACrD,iCAAiC,EAAE,cAAc;IACjD,mCAAmC,EAAE,YAAY;IACjD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;CACb,CAAC;AAEF,MAAM,mBAAmB,GAAG,aAAa,CAAsB,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,CAAC,CAAC;AAW9G;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,EAAE,gBAAgB,EAAE,QAAQ,EAAuD;IAC7H,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,gBAAgB,EAAE,EAAE,GAAG,uBAAuB,EAAE,GAAG,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAE9G,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,EAAE,gBAAgB,EAAE,EAAE,GAAG,uBAAuB,EAAE,GAAG,gBAAgB,EAAE,EAAE,CAAC,CAAC;IACtF,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB,OAAO,KAAC,mBAAmB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAAgC,CAAC;AAC/F,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,sBAAsB;IACpC,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC;AACzC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { createContext, PropsWithChildren, useContext, useEffect, useState } from \"react\";\n\n/**\n * Localized strings used in the components.\n * @public\n */\nexport interface LocalizedStrings {\n  /**\n   * Message displayed when nodes are loading.\n   * Default value: `Loading...`.\n   */\n  loading: string;\n  /**\n   * Title for apply hierarchy filter button.\n   * Default value: `Apply filter`.\n   */\n  filterHierarchyLevel: string;\n  /**\n   * Accessible description for applied hierarchy filter button.\n   * Default value: `Filter is applied`.\n   */\n  filterHierarchyLevelActiveDescription: string;\n  /**\n   * Title for clear hierarchy filter button.\n   * Default value: `Clear active filter`.\n   */\n  clearHierarchyLevelFilter: string;\n  /**\n   * Message displayed when no nodes matching filter are found.\n   * Default value: `No matches for current filter for {{node}}.`.\n   */\n  noFilteredChildren: string;\n  /**\n   * Label for change filter action.\n   * Default value: `Change filter`.\n   */\n  noFilteredChildrenChangeFilter: string;\n  /**\n   * Message displayed when hierarchy creation for a node failed.\n   * Default value: `Failed to create hierarchy for {{node}}.`.\n   */\n  failedToCreateHierarchy: string;\n  /**\n   * Message displayed when hierarchy creation for a node failed.\n   * Default value: `Failed to load tree.`.\n   */\n  failedToCreateRootHierarchy: string;\n  /**\n   * Message displayed when result limit exceeds hierarchy size limit.\n   * Default value: `The hierarchy for {{node}} contains {{limit}}+ items. Try using filters or increase the limit.`.\n   */\n  resultLimitExceeded: string;\n  /**\n   * Message displayed when result limit exceeds hierarchy size limit.\n   * Default value: `The root item hierarchy contains {{limit}}+ items. Try increasing the limit.`.\n   */\n  rootResultLimitExceeded: string;\n  /**\n   * Name for the error region landmark.\n   * Default value: `Issues for {{tree_label}}.`.\n   */\n  issuesForTree: string;\n  /**\n   * Label displayed on the error region, when errors are detected.\n   * Default value: `{{number_of_issues}} issue(s) found.`.\n   */\n  issuesFound: string;\n  /**\n   * Label displayed on the error region, when no issues are found.\n   * Default value: `No issues found.`.\n   */\n  noIssuesFound: string;\n  /**\n   * Message displayed when hierarchy size limit can be overridden.\n   * Default value: `Increase limit to {{limit}}`.\n   */\n  increaseHierarchyLimit: string;\n  /**\n   * Message displayed when hierarchy size limit can be overridden.\n   * Default value: `Remove limit`.\n   */\n  increaseHierarchyLimitToUnlimited: string;\n  /**\n   * Message displayed when hierarchy size limit can be overridden and hierarchy filtering is enabled.\n   * Default value: `Add Filter`.\n   */\n  increaseHierarchyLimitWithFiltering: string;\n  /**\n   * Label for retry action.\n   * Default value: `Retry`.\n   */\n  retry: string;\n  /**\n   * Label for rename action.\n   * Default value: `Rename`.\n   */\n  rename: string;\n  /**\n   * Label for more actions button.\n   * Default value: `More`.\n   */\n  more: string;\n}\n\n/** @internal */\nexport interface LocalizationContext {\n  localizedStrings: LocalizedStrings;\n}\n\nconst defaultLocalizedStrings: LocalizedStrings = {\n  loading: \"Loading...\",\n  filterHierarchyLevel: \"Apply filter\",\n  filterHierarchyLevelActiveDescription: \"Filter is applied\",\n  clearHierarchyLevelFilter: \"Clear active filter\",\n  noFilteredChildren: \"No matches for current filter for {{node}}.\",\n  noFilteredChildrenChangeFilter: \"Change filter\",\n  failedToCreateHierarchy: \"Failed to create hierarchy for {{node}}.\",\n  failedToCreateRootHierarchy: \"Failed to load tree.\",\n  resultLimitExceeded: \"The hierarchy for {{node}} contains {{limit}}+ items. Try using filters or increase the limit.\",\n  rootResultLimitExceeded: \"The root item hierarchy contains {{limit}}+ items. Try increasing the limit.\",\n  issuesForTree: \"Issues for {{tree_label}}.\",\n  issuesFound: \"{{number_of_issues}} issue(s) found.\",\n  noIssuesFound: \"No issues found.\",\n  increaseHierarchyLimit: \"Increase limit to {{limit}}\",\n  increaseHierarchyLimitToUnlimited: \"Remove limit\",\n  increaseHierarchyLimitWithFiltering: \"Add Filter\",\n  retry: \"Retry\",\n  rename: \"Rename\",\n  more: \"More\",\n};\n\nconst localizationContext = createContext<LocalizationContext>({ localizedStrings: defaultLocalizedStrings });\n\n/**\n * Properties for `LocalizationContextProvider`.\n * @public\n */\ninterface LocalizationContextProviderProps {\n  /** Localized strings used in the components. */\n  localizedStrings?: Partial<LocalizedStrings>;\n}\n\n/**\n * Context provider for localized strings used in the components.\n * @public\n */\nexport function LocalizationContextProvider({ localizedStrings, children }: PropsWithChildren<LocalizationContextProviderProps>) {\n  const [state, setState] = useState({ localizedStrings: { ...defaultLocalizedStrings, ...localizedStrings } });\n\n  useEffect(() => {\n    setState({ localizedStrings: { ...defaultLocalizedStrings, ...localizedStrings } });\n  }, [localizedStrings]);\n\n  return <localizationContext.Provider value={state}>{children}</localizationContext.Provider>;\n}\n\n/** @internal */\nexport function useLocalizationContext() {\n  return useContext(localizationContext);\n}\n"]}

package/lib/esm/presentation-hierarchies-react/stratakit/RenameAction.d.ts

@@ -0,0 +1,33 @@
+import { PropsWithChildren } from "react";
+/**
+ * @alpha
+ */
+interface RenameActionProps {
+    /**
+     * Indicates that space for this action button should be reserved, even when the action is not available.
+     * For nodes that don't support renaming, `<RenameAction reserveSpace />` renders:
+     *
+     * - Blank space when the action is used as an inline action. It's recommended to set this prop to keep all action buttons of the same kind vertically aligned.
+     * - Disabled menu item when the action is used as a menu action.
+     */
+    reserveSpace?: true;
+}
+/**
+ * React component that renders a rename action for a tree item.
+ * The tree component must have `getEditingProps.onLabelChanged` prop set to enable renaming functionality. When the rename is completed, the `onLabelChanged` function is called to make the actual data update.
+ * @alpha
+ */
+export declare const RenameAction: import("react").NamedExoticComponent<RenameActionProps>;
+interface RenameContext {
+    isRenaming: boolean;
+    setIsRenaming: (isRenaming: boolean) => void;
+    onLabelChanged?: (newLabel: string) => void;
+}
+/** @internal */
+export declare const useRenameContext: () => RenameContext | undefined;
+/** @alpha */
+export declare function RenameContextProvider({ onLabelChanged, children }: PropsWithChildren<{
+    onLabelChanged?: (newLabel: string) => void;
+}>): import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=RenameAction.d.ts.map

package/lib/esm/presentation-hierarchies-react/stratakit/RenameAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenameAction.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/RenameAction.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAuB,iBAAiB,EAA8C,MAAM,OAAO,CAAC;AAK3G;;GAEG;AACH,UAAU,iBAAiB;IACzB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED;;;;GAIG;AACH,eAAO,MAAM,YAAY,yDAevB,CAAC;AAEH,UAAU,aAAa;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAC7C,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7C;AAID,gBAAgB;AAChB,eAAO,MAAM,gBAAgB,iCAE5B,CAAC;AAEF,aAAa;AACb,wBAAgB,qBAAqB,CAAC,EAAE,cAAc,EAAE,QAAQ,EAAE,EAAE,iBAAiB,CAAC;IAAE,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,CAAC,2CAKrI"}

package/lib/esm/presentation-hierarchies-react/stratakit/RenameAction.js

@@ -0,0 +1,39 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { createContext, memo, useCallback, useContext, useMemo, useState } from "react";
+import renameSvg from "@stratakit/icons/rename.svg";
+import { Tree } from "@stratakit/structures";
+import { useLocalizationContext } from "./LocalizationContext.js";
+/**
+ * React component that renders a rename action for a tree item.
+ * The tree component must have `getEditingProps.onLabelChanged` prop set to enable renaming functionality. When the rename is completed, the `onLabelChanged` function is called to make the actual data update.
+ * @alpha
+ */
+export const RenameAction = memo(function RenameAction({ reserveSpace }) {
+    const { localizedStrings } = useLocalizationContext();
+    const context = useRenameContext();
+    const { rename } = localizedStrings;
+    const setIsRenaming = context?.setIsRenaming;
+    const handleClick = useCallback(() => {
+        setIsRenaming?.(true);
+    }, [setIsRenaming]);
+    if (!context?.onLabelChanged) {
+        return reserveSpace ? _jsx(Tree.ItemAction, { label: rename, icon: renameSvg, visible: false, disabled: true }) : undefined;
+    }
+    return _jsx(Tree.ItemAction, { label: rename, onClick: handleClick, icon: renameSvg });
+});
+const renameContext = createContext(undefined);
+/** @internal */
+export const useRenameContext = () => {
+    return useContext(renameContext);
+};
+/** @alpha */
+export function RenameContextProvider({ onLabelChanged, children }) {
+    const [isRenaming, setIsRenaming] = useState(false);
+    const value = useMemo(() => ({ isRenaming, setIsRenaming, onLabelChanged }), [isRenaming, onLabelChanged]);
+    return _jsx(renameContext.Provider, { value: value, children: children });
+}
+//# sourceMappingURL=RenameAction.js.map

package/lib/esm/presentation-hierarchies-react/stratakit/RenameAction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RenameAction.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/RenameAction.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,IAAI,EAAqB,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC3G,OAAO,SAAS,MAAM,6BAA6B,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAgBlE;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,YAAY,CAAC,EAAE,YAAY,EAAqB;IACxF,MAAM,EAAE,gBAAgB,EAAE,GAAG,sBAAsB,EAAE,CAAC;IACtD,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;IAEpC,MAAM,aAAa,GAAG,OAAO,EAAE,aAAa,CAAC;IAC7C,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACnC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,CAAC;QAC7B,OAAO,YAAY,CAAC,CAAC,CAAC,KAAC,IAAI,CAAC,UAAU,IAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,SAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACjH,CAAC;IAED,OAAO,KAAC,IAAI,CAAC,UAAU,IAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,GAAI,CAAC;AACnF,CAAC,CAAC,CAAC;AAQH,MAAM,aAAa,GAAG,aAAa,CAA4B,SAAS,CAAC,CAAC;AAE1E,gBAAgB;AAChB,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,OAAO,UAAU,CAAC,aAAa,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,aAAa;AACb,MAAM,UAAU,qBAAqB,CAAC,EAAE,cAAc,EAAE,QAAQ,EAAsE;IACpI,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC;IAE3G,OAAO,KAAC,aAAa,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAA0B,CAAC;AACnF,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { createContext, memo, PropsWithChildren, useCallback, useContext, useMemo, useState } from \"react\";\nimport renameSvg from \"@stratakit/icons/rename.svg\";\nimport { Tree } from \"@stratakit/structures\";\nimport { useLocalizationContext } from \"./LocalizationContext.js\";\n\n/**\n * @alpha\n */\ninterface RenameActionProps {\n  /**\n   * Indicates that space for this action button should be reserved, even when the action is not available.\n   * For nodes that don't support renaming, `<RenameAction reserveSpace />` renders:\n   *\n   * - Blank space when the action is used as an inline action. It's recommended to set this prop to keep all action buttons of the same kind vertically aligned.\n   * - Disabled menu item when the action is used as a menu action.\n   */\n  reserveSpace?: true;\n}\n\n/**\n * React component that renders a rename action for a tree item.\n * The tree component must have `getEditingProps.onLabelChanged` prop set to enable renaming functionality. When the rename is completed, the `onLabelChanged` function is called to make the actual data update.\n * @alpha\n */\nexport const RenameAction = memo(function RenameAction({ reserveSpace }: RenameActionProps) {\n  const { localizedStrings } = useLocalizationContext();\n  const context = useRenameContext();\n  const { rename } = localizedStrings;\n\n  const setIsRenaming = context?.setIsRenaming;\n  const handleClick = useCallback(() => {\n    setIsRenaming?.(true);\n  }, [setIsRenaming]);\n\n  if (!context?.onLabelChanged) {\n    return reserveSpace ? <Tree.ItemAction label={rename} icon={renameSvg} visible={false} disabled /> : undefined;\n  }\n\n  return <Tree.ItemAction label={rename} onClick={handleClick} icon={renameSvg} />;\n});\n\ninterface RenameContext {\n  isRenaming: boolean;\n  setIsRenaming: (isRenaming: boolean) => void;\n  onLabelChanged?: (newLabel: string) => void;\n}\n\nconst renameContext = createContext<RenameContext | undefined>(undefined);\n\n/** @internal */\nexport const useRenameContext = () => {\n  return useContext(renameContext);\n};\n\n/** @alpha */\nexport function RenameContextProvider({ onLabelChanged, children }: PropsWithChildren<{ onLabelChanged?: (newLabel: string) => void }>) {\n  const [isRenaming, setIsRenaming] = useState(false);\n  const value = useMemo(() => ({ isRenaming, setIsRenaming, onLabelChanged }), [isRenaming, onLabelChanged]);\n\n  return <renameContext.Provider value={value}>{children}</renameContext.Provider>;\n}\n"]}

package/lib/esm/presentation-hierarchies-react/stratakit/RootErrorRenderer.d.ts

@@ -0,0 +1,16 @@
+import { RootErrorRendererProps } from "../Renderers.js";
+import { ErrorInfo } from "../TreeNode.js";
+/**
+ * @alpha
+ */
+export type StrataKitRootErrorRendererProps = {
+    /** Root error to be displayed */
+    error: ErrorInfo;
+} & RootErrorRendererProps;
+/**
+ * A component that renders root node error state.
+ *
+ * @alpha
+ */
+export declare function StrataKitRootErrorRenderer({ error, getHierarchyLevelDetails, reloadTree }: StrataKitRootErrorRendererProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=RootErrorRenderer.d.ts.map

package/lib/esm/presentation-hierarchies-react/stratakit/RootErrorRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RootErrorRenderer.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/RootErrorRenderer.tsx"],"names":[],"mappings":"AAQA,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,iCAAiC;IACjC,KAAK,EAAE,SAAS,CAAC;CAClB,GAAG,sBAAsB,CAAC;AAE3B;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,EAAE,KAAK,EAAE,wBAAwB,EAAE,UAAU,EAAE,EAAE,+BAA+B,2CA+B1H"}

package/lib/esm/presentation-hierarchies-react/stratakit/RootErrorRenderer.js

@@ -0,0 +1,42 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { Button, Text } from "@stratakit/bricks";
+import { Icon } from "@stratakit/foundations";
+import errorSvg from "@stratakit/icons/status-error.svg";
+import { useLocalizationContext } from "./LocalizationContext.js";
+/**
+ * A component that renders root node error state.
+ *
+ * @alpha
+ */
+export function StrataKitRootErrorRenderer({ error, getHierarchyLevelDetails, reloadTree }) {
+    const { localizedStrings } = useLocalizationContext();
+    if (error.type === "ResultSetTooLarge") {
+        const onOverrideLimit = () => getHierarchyLevelDetails(undefined)?.setSizeLimit("unbounded");
+        return (_jsx(RootErrorContainer, { message: localizedStrings.rootResultLimitExceeded.replace("{{limit}}", error.resultSetSizeLimit.toString()), actions: [
+                {
+                    action: onOverrideLimit,
+                    label: localizedStrings.increaseHierarchyLimitToUnlimited,
+                    condition: () => true,
+                },
+            ] }));
+    }
+    return (_jsx(RootErrorContainer, { message: localizedStrings.failedToCreateRootHierarchy, actions: [
+            {
+                action: () => reloadTree({ parentNodeId: undefined, state: "reset" }),
+                label: localizedStrings.retry,
+                condition: () => true,
+            },
+        ] }));
+}
+function RootErrorContainer({ actions, message }) {
+    return (_jsxs("div", { style: { height: "100%", display: "flex", flexDirection: "column", justifyContent: "center", alignItems: "center", gap: "0.5rem" }, children: [_jsx(Icon, { href: errorSvg, size: "large" }), _jsx(Text, { variant: "body-sm", style: { textAlign: "center" }, children: message }), actions
+                ?.filter(({ condition }) => condition())
+                .map((action) => {
+                return (_jsx(Button, { onClick: () => action.action(), children: action.label }, action.label));
+            })] }));
+}
+//# sourceMappingURL=RootErrorRenderer.js.map

package/lib/esm/presentation-hierarchies-react/stratakit/RootErrorRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RootErrorRenderer.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/RootErrorRenderer.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,QAAQ,MAAM,mCAAmC,CAAC;AAGzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAUlE;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,EAAE,KAAK,EAAE,wBAAwB,EAAE,UAAU,EAAmC;IACzH,MAAM,EAAE,gBAAgB,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAEtD,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QACvC,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;QAC7F,OAAO,CACL,KAAC,kBAAkB,IACjB,OAAO,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,EAC3G,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE,eAAe;oBACvB,KAAK,EAAE,gBAAgB,CAAC,iCAAiC;oBACzD,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;iBACtB;aACF,GACD,CACH,CAAC;IACJ,CAAC;IAED,OAAO,CACL,KAAC,kBAAkB,IACjB,OAAO,EAAE,gBAAgB,CAAC,2BAA2B,EACrD,OAAO,EAAE;YACP;gBACE,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;gBACrE,KAAK,EAAE,gBAAgB,CAAC,KAAK;gBAC7B,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;aACtB;SACF,GACD,CACH,CAAC;AACJ,CAAC;AAOD,SAAS,kBAAkB,CAAC,EAAE,OAAO,EAAE,OAAO,EAA2B;IACvE,OAAO,CACL,eAAK,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,aACrI,KAAC,IAAI,IAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAC,OAAO,GAAG,EACrC,KAAC,IAAI,IAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,YACrD,OAAO,GACH,EACN,OAAO;gBACN,EAAE,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE,CAAC;iBACvC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;gBACd,OAAO,CACL,KAAC,MAAM,IAAoB,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,YACtD,MAAM,CAAC,KAAK,IADF,MAAM,CAAC,KAAK,CAEhB,CACV,CAAC;YACJ,CAAC,CAAC,IACA,CACP,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { Button, Text } from \"@stratakit/bricks\";\nimport { Icon } from \"@stratakit/foundations\";\nimport errorSvg from \"@stratakit/icons/status-error.svg\";\nimport { RootErrorRendererProps } from \"../Renderers.js\";\nimport { ErrorInfo } from \"../TreeNode.js\";\nimport { useLocalizationContext } from \"./LocalizationContext.js\";\n\n/**\n * @alpha\n */\nexport type StrataKitRootErrorRendererProps = {\n  /** Root error to be displayed */\n  error: ErrorInfo;\n} & RootErrorRendererProps;\n\n/**\n * A component that renders root node error state.\n *\n * @alpha\n */\nexport function StrataKitRootErrorRenderer({ error, getHierarchyLevelDetails, reloadTree }: StrataKitRootErrorRendererProps) {\n  const { localizedStrings } = useLocalizationContext();\n\n  if (error.type === \"ResultSetTooLarge\") {\n    const onOverrideLimit = () => getHierarchyLevelDetails(undefined)?.setSizeLimit(\"unbounded\");\n    return (\n      <RootErrorContainer\n        message={localizedStrings.rootResultLimitExceeded.replace(\"{{limit}}\", error.resultSetSizeLimit.toString())}\n        actions={[\n          {\n            action: onOverrideLimit,\n            label: localizedStrings.increaseHierarchyLimitToUnlimited,\n            condition: () => true,\n          },\n        ]}\n      />\n    );\n  }\n\n  return (\n    <RootErrorContainer\n      message={localizedStrings.failedToCreateRootHierarchy}\n      actions={[\n        {\n          action: () => reloadTree({ parentNodeId: undefined, state: \"reset\" }),\n          label: localizedStrings.retry,\n          condition: () => true,\n        },\n      ]}\n    />\n  );\n}\n\ninterface RootErrorContainerProps {\n  message: string;\n  actions?: { action: () => void; label: string; condition: () => boolean }[];\n}\n\nfunction RootErrorContainer({ actions, message }: RootErrorContainerProps) {\n  return (\n    <div style={{ height: \"100%\", display: \"flex\", flexDirection: \"column\", justifyContent: \"center\", alignItems: \"center\", gap: \"0.5rem\" }}>\n      <Icon href={errorSvg} size=\"large\" />\n      <Text variant={\"body-sm\"} style={{ textAlign: \"center\" }}>\n        {message}\n      </Text>\n      {actions\n        ?.filter(({ condition }) => condition())\n        .map((action) => {\n          return (\n            <Button key={action.label} onClick={() => action.action()}>\n              {action.label}\n            </Button>\n          );\n        })}\n    </div>\n  );\n}\n"]}

package/lib/esm/presentation-hierarchies-react/stratakit/TreeErrorRenderer.d.ts

@@ -0,0 +1,47 @@
+import { ReactElement } from "react";
+import { HierarchyLevelDetails, TreeRendererProps } from "../Renderers.js";
+import { ErrorItemRendererProps } from "./ErrorItemRenderer.js";
+import { ErrorItem } from "./FlatTreeNode.js";
+/**
+ * Interface containing error item related actions.
+ *
+ * @alpha
+ */
+interface TreeErrorItemProps {
+    /** A callback to reload a hierarchy level when an error occurs and `retry` button is clicked. */
+    reloadTree: (options: {
+        parentNodeId: string | undefined;
+        state: "reset";
+    }) => void;
+    /** Action to perform when the filter button is clicked for this node. */
+    onFilterClick?: (hierarchyLevelDetails: HierarchyLevelDetails) => void;
+    /** Action to perform when an error occurs and node label is clicked in the error message */
+    scrollToElement: (errorNode: ErrorItem) => void;
+}
+/**
+ * Interface containing building blocks for `TreeErrorRenderer`.
+ *
+ * @alpha
+ */
+interface TreeErrorRendererOwnProps {
+    /**
+     * A user friendly display label of the tree. Should be unique within the consuming application,
+     * as it's used for creating a unique accessible label for the error region.
+     */
+    treeLabel: string;
+    /** List of errors to be displayed */
+    errorList: ErrorItem[];
+    /** Callback to render custom error messages. Component should be wrapped in `ErrorRegion.Item` from `@itwin/itwinui-react` package. */
+    renderError?: (props: ErrorItemRendererProps) => ReactElement;
+}
+/** @alpha */
+export type TreeErrorRendererProps = TreeErrorRendererOwnProps & TreeErrorItemProps & Pick<TreeRendererProps, "getHierarchyLevelDetails">;
+/**
+ * A component that renders error display dropdown using the `unstable_ErrorRegion` component from `@itwin/itwinui-react`.
+ * As input, the component uses a list of `ErrorNode` objects, which are generally created using the `useErrorList` hook.
+ *
+ * @alpha
+ */
+export declare function TreeErrorRenderer({ treeLabel, errorList, reloadTree, scrollToElement, getHierarchyLevelDetails, onFilterClick, renderError, }: TreeErrorRendererProps): import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=TreeErrorRenderer.d.ts.map

package/lib/esm/presentation-hierarchies-react/stratakit/TreeErrorRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeErrorRenderer.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/stratakit/TreeErrorRenderer.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAErC,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,EAAqB,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACnF,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAG9C;;;;GAIG;AACH,UAAU,kBAAkB;IAC1B,iGAAiG;IACjG,UAAU,EAAE,CAAC,OAAO,EAAE;QAAE,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC;IACpF,yEAAyE;IACzE,aAAa,CAAC,EAAE,CAAC,qBAAqB,EAAE,qBAAqB,KAAK,IAAI,CAAC;IACvE,4FAA4F;IAC5F,eAAe,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;CACjD;AACD;;;;GAIG;AACH,UAAU,yBAAyB;IACjC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,SAAS,EAAE,SAAS,EAAE,CAAC;IACvB,uIAAuI;IACvI,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,YAAY,CAAC;CAC/D;AAED,aAAa;AACb,MAAM,MAAM,sBAAsB,GAAG,yBAAyB,GAAG,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,EAAE,0BAA0B,CAAC,CAAC;AAE1I;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,SAAS,EACT,SAAS,EACT,UAAU,EACV,eAAe,EACf,wBAAwB,EACxB,aAAa,EACb,WAAW,GACZ,EAAE,sBAAsB,2CA4BxB"}

package/lib/esm/presentation-hierarchies-react/stratakit/TreeErrorRenderer.js

@@ -0,0 +1,28 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { unstable_ErrorRegion as ErrorRegion } from "@stratakit/structures";
+import { ErrorItemRenderer } from "./ErrorItemRenderer.js";
+import { useLocalizationContext } from "./LocalizationContext.js";
+/**
+ * A component that renders error display dropdown using the `unstable_ErrorRegion` component from `@itwin/itwinui-react`.
+ * As input, the component uses a list of `ErrorNode` objects, which are generally created using the `useErrorList` hook.
+ *
+ * @alpha
+ */
+export function TreeErrorRenderer({ treeLabel, errorList, reloadTree, scrollToElement, getHierarchyLevelDetails, onFilterClick, renderError, }) {
+    const { localizedStrings } = useLocalizationContext();
+    const errorItems = errorList.map((errorItem) => {
+        const errorRendererProps = {
+            errorItem,
+            scrollToElement: () => scrollToElement(errorItem),
+            reloadTree,
+            getHierarchyLevelDetails,
+            onFilterClick,
+        };
+        if (renderError) {
+            return renderError(errorRendererProps);
+        }
+        return _jsx(ErrorItemRenderer, { ...errorRendererProps }, errorItem.errorNode.id);
+    });
+    return (_jsx(ErrorRegion.Root, { style: { width: "100%" }, "aria-label": localizedStrings.issuesForTree.replace("{{tree_label}}", treeLabel), label: errorList.length === 0 ? localizedStrings.noIssuesFound : localizedStrings.issuesFound.replace("{{number_of_issues}}", errorList.length.toString()), items: errorItems }));
+}
+//# sourceMappingURL=TreeErrorRenderer.js.map