@itwin/presentation-hierarchies-react 2.0.0-alpha.1 → 2.0.0-alpha.11

package/CHANGELOG.md

@@ -1,5 +1,106 @@
 # @itwin/presentation-hierarchies-react
 
+## 2.0.0-alpha.11
+
+### Patch Changes
+
+- [#916](https://github.com/iTwin/presentation/pull/916): Fix tree nodes overlapping when nodes with and without sublabel are rendered alongside.
+- [#920](https://github.com/iTwin/presentation/pull/920): Changed error display for node errors to match new design system.
+
+## 2.0.0-alpha.10
+
+### Patch Changes
+
+- [#913](https://github.com/iTwin/presentation/pull/913): Removed outline showed after node expander is clicked.
+
+## 2.0.0-alpha.9
+
+### Patch Changes
+
+- [#906](https://github.com/iTwin/presentation/pull/906): Replaced `TreeNodeRenderer.getIcon` prop with `getDecorations` prop.
+
+  The `getIcon` prop took either an icon URI, or a `ReactElement`. The new `getDecorations` prop allows passing multiple React elements, allowing consumers to render not just the icon, but also addition components like a tag or a color swatch. Migration:
+
+  ```ts
+  // previously, when `getIcon` returned a `ReactElement`:
+  function myGetIcon(node: PresentationHierarchyNode): React.ReactElement {
+    // implementation...
+  }
+  <TreeNodeRenderer getIcon={myGetIcon} />
+
+  // now:
+  <TreeNodeRenderer getDecorations={myGetIcon} />
+
+  // previously, when `getIcon` returned an icon URI:
+  function myGetIconUri(node: PresentationHierarchyNode): string {
+    // implementation...
+  }
+  <TreeNodeRenderer getIcon={myGetIconUri} />
+
+  // now:
+  <TreeNodeRenderer getDecorations={(node) => <Icon href={myGetIconUri(node)} />} />
+  ```
+
+- [#911](https://github.com/iTwin/presentation/pull/911): Fix incorrect left padding on tree items
+
+## 2.0.0-alpha.8
+
+### Patch Changes
+
+- [#903](https://github.com/iTwin/presentation/pull/903): Added `activeDescription` optional property to TreeItemAction interface, which when provided a value will display a dot above the button indicating an active state. The provided value is used to set accesible description and should explain why the action item is active.
+- [#903](https://github.com/iTwin/presentation/pull/903): Changed `createFilterAction` function to a React hook and renamed it to `useFilterAction`.
+
+## 2.0.0-alpha.7
+
+### Patch Changes
+
+- [#892](https://github.com/iTwin/presentation/pull/892): Fix focus outline for tree items not being visible on action items click.
+- [#894](https://github.com/iTwin/presentation/pull/894): Fix `treeRenderer` property `getSublabel` not being used.
+
+## 2.0.0-alpha.6
+
+### Patch Changes
+
+- [#890](https://github.com/iTwin/presentation/pull/890): Fix alpha peer dependencies to no longer have caret.
+
+## 2.0.0-alpha.5
+
+### Minor Changes
+
+- [#883](https://github.com/iTwin/presentation/pull/883): Trees rendered with `TreeRenderer` will now be virtualized.
+
+## 2.0.0-alpha.4
+
+### Minor Changes
+
+- [#878](https://github.com/iTwin/presentation/pull/878): Tree node renderer now uses `Tree.ItemAction`. `Show` property now takes in undefined values, values behave like this:
+
+  - `undefined` - visible on hover/focus,
+  - `true` - visible at all times,
+  - `false` - hidden at all times.
+
+  Updated peer dependencies:
+
+  - itwinui-icons to 5.0.0-alpha.3,
+  - itwinui-react to 5.0.0-alpha.6,
+
+## 2.0.0-alpha.3
+
+### Patch Changes
+
+- [#870](https://github.com/iTwin/presentation/pull/870): `TreeRenderer` and `TreeNodeRenderer` now take actions as specification function array.
+
+  - `label`: Action item's label.
+  - `action`: The action performed when the button is clicked.
+  - `show` A boolean determining whether the button should be displayed.
+  - `icon`: The button's icon.
+
+## 2.0.0-alpha.2
+
+### Major Changes
+
+- [#864](https://github.com/iTwin/presentation/pull/864): Add `@itwin/itwinui-icons` as optional peer dependency (only required when using iTwinUI-based tree / node renderers).
+
 ## 2.0.0-alpha.1
 
 ### Patch Changes
@@ -20,6 +121,36 @@
 
 - [#847](https://github.com/iTwin/presentation/pull/847): Moving tree rendering components to a new design systems.
 
+## 1.6.4
+
+### Patch Changes
+
+- [#909](https://github.com/iTwin/presentation/pull/909): Do not use `dev` versions of `@itwin/*` packages.
+- Updated dependencies:
+  - @itwin/unified-selection@1.4.1
+  - @itwin/presentation-hierarchies@1.4.2
+  - @itwin/presentation-shared@1.2.1
+
+## 1.6.3
+
+### Patch Changes
+
+- Updated dependencies:
+  - @itwin/unified-selection@1.4.0
+
+## 1.6.2
+
+### Patch Changes
+
+- [#873](https://github.com/iTwin/presentation/pull/873): Fix hierarchy level size exceeds limit info message wrapping in narrow Tree on Safari browser.
+- [#873](https://github.com/iTwin/presentation/pull/873): Do not require two clicks to expand node with filter buttons on touch devices.
+
+## 1.6.1
+
+### Patch Changes
+
+- [#866](https://github.com/iTwin/presentation/pull/866): Updated hierarchy level size exceeded info message styling in narrow tree component to avoid cutting out text.
+
 ## 1.6.0
 
 ### Minor Changes

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

@@ -0,0 +1,28 @@
+import { PresentationHierarchyNode, PresentationInfoNode, PresentationTreeNode } from "../TreeNode.js";
+/** @alpha */
+interface PlaceholderNode {
+    id: string;
+    level: number;
+    placeholder: true;
+}
+/** @alpha */
+export type FlatNode = {
+    level: number;
+    levelSize: number;
+    posInLevel: number;
+} & PresentationHierarchyNode;
+/** @alpha */
+export interface ErrorNode {
+    error: PresentationInfoNode;
+    parent?: PresentationHierarchyNode;
+    expandTo: (expandNode: (nodeId: string) => void) => void;
+}
+/** @alpha */
+export type FlatTreeNode = FlatNode | PlaceholderNode;
+/** @alpha */
+export declare function isPlaceholderNode(node: FlatTreeNode): node is PlaceholderNode;
+/** @alpha */
+export declare function flattenNodes(rootNodes: PresentationTreeNode[]): FlatTreeNode[];
+export declare function getErrors(rootNodes: PresentationTreeNode[]): ErrorNode[];
+export {};
+//# sourceMappingURL=FlatTreeNode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FlatTreeNode.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/FlatTreeNode.ts"],"names":[],"mappings":"AAKA,OAAO,EAA+B,yBAAyB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAEpI,aAAa;AACb,UAAU,eAAe;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,IAAI,CAAC;CACnB;AAED,aAAa;AACb,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,yBAAyB,CAAC;AAE9B,aAAa;AACb,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,oBAAoB,CAAC;IAC5B,MAAM,CAAC,EAAE,yBAAyB,CAAC;IACnC,QAAQ,EAAE,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAC;CAC1D;AAED,aAAa;AACb,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,eAAe,CAAC;AAEtD,aAAa;AACb,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,IAAI,eAAe,CAE7E;AAED,aAAa;AACb,wBAAgB,YAAY,CAAC,SAAS,EAAE,oBAAoB,EAAE,kBAE7D;AAuBD,wBAAgB,SAAS,CAAC,SAAS,EAAE,oBAAoB,EAAE,GAAG,SAAS,EAAE,CAUxE"}

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

@@ -0,0 +1,66 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { isPresentationHierarchyNode } from "../TreeNode.js";
+/** @alpha */
+export function isPlaceholderNode(node) {
+    return "placeholder" in node;
+}
+/** @alpha */
+export function flattenNodes(rootNodes) {
+    return getFlatNodes(rootNodes, 1);
+}
+function getFlatNodes(nodes, level) {
+    const flatNodes = [];
+    nodes.forEach((node, index) => {
+        if (!isPresentationHierarchyNode(node)) {
+            return;
+        }
+        flatNodes.push({ ...node, level, levelSize: nodes.length, posInLevel: index + 1 });
+        if (!node.isExpanded) {
+            return;
+        }
+        if (node.children !== true) {
+            const childNodes = getFlatNodes(node.children, level + 1);
+            flatNodes.push(...childNodes);
+            return;
+        }
+        flatNodes.push({ id: `${node.id}-children-placeholder`, level: level + 1, placeholder: true });
+    });
+    return flatNodes;
+}
+export function getErrors(rootNodes) {
+    return rootNodes.flatMap((rootNode) => {
+        if (!isPresentationHierarchyNode(rootNode)) {
+            return [{ parent: undefined, error: rootNode, expandTo: (expandNode) => expandTo(expandNode, []) }];
+        }
+        if (rootNode.children === true) {
+            return [];
+        }
+        return getErrorNodes(rootNode, !rootNode.isExpanded ? [rootNode.id] : []);
+    });
+}
+function getErrorNodes(parent, path) {
+    const errorList = [];
+    if (parent.children === true) {
+        return [];
+    }
+    const pathToChild = [...path, ...(!parent.isExpanded ? [parent.id] : [])];
+    parent.children.forEach((node) => {
+        if (!isPresentationHierarchyNode(node)) {
+            errorList.push({ parent, error: node, expandTo: (expandNode) => expandTo(expandNode, path) });
+            return;
+        }
+        if (node.children !== true) {
+            const childErrorList = getErrorNodes(node, pathToChild);
+            errorList.push(...childErrorList);
+            return;
+        }
+    });
+    return errorList;
+}
+function expandTo(expandNode, path) {
+    path.forEach((nodeId) => expandNode(nodeId));
+}
+//# sourceMappingURL=FlatTreeNode.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FlatTreeNode.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/FlatTreeNode.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,2BAA2B,EAAyE,MAAM,gBAAgB,CAAC;AA0BpI,aAAa;AACb,MAAM,UAAU,iBAAiB,CAAC,IAAkB;IAClD,OAAO,aAAa,IAAI,IAAI,CAAC;AAC/B,CAAC;AAED,aAAa;AACb,MAAM,UAAU,YAAY,CAAC,SAAiC;IAC5D,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,YAAY,CAAC,KAA6B,EAAE,KAAa;IAChE,MAAM,SAAS,GAAmB,EAAE,CAAC;IACrC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,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,EAA4B,CAAC,CAAC;IAC3H,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,SAAiC;IACzD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpC,IAAI,CAAC,2BAA2B,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3C,OAAO,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACtG,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,CAAC;AACL,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,CAAC,2BAA2B,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;YAC9F,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","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 { isPresentationHierarchyNode, PresentationHierarchyNode, PresentationInfoNode, PresentationTreeNode } from \"../TreeNode.js\";\n\n/** @alpha */\ninterface PlaceholderNode {\n  id: string;\n  level: number;\n  placeholder: true;\n}\n\n/** @alpha */\nexport type FlatNode = {\n  level: number;\n  levelSize: number;\n  posInLevel: number;\n} & PresentationHierarchyNode;\n\n/** @alpha */\nexport interface ErrorNode {\n  error: PresentationInfoNode;\n  parent?: PresentationHierarchyNode;\n  expandTo: (expandNode: (nodeId: string) => void) => void;\n}\n\n/** @alpha */\nexport type FlatTreeNode = FlatNode | PlaceholderNode;\n\n/** @alpha */\nexport function isPlaceholderNode(node: FlatTreeNode): node is PlaceholderNode {\n  return \"placeholder\" in node;\n}\n\n/** @alpha */\nexport function flattenNodes(rootNodes: PresentationTreeNode[]) {\n  return getFlatNodes(rootNodes, 1);\n}\n\nfunction getFlatNodes(nodes: PresentationTreeNode[], level: number) {\n  const flatNodes: FlatTreeNode[] = [];\n  nodes.forEach((node, index) => {\n    if (!isPresentationHierarchyNode(node)) {\n      return;\n    }\n    flatNodes.push({ ...node, level, levelSize: nodes.length, posInLevel: index + 1 });\n    if (!node.isExpanded) {\n      return;\n    }\n    if (node.children !== true) {\n      const childNodes = getFlatNodes(node.children, level + 1);\n      flatNodes.push(...childNodes);\n      return;\n    }\n\n    flatNodes.push({ id: `${node.id}-children-placeholder`, level: level + 1, placeholder: true } satisfies PlaceholderNode);\n  });\n  return flatNodes;\n}\n\nexport function getErrors(rootNodes: PresentationTreeNode[]): ErrorNode[] {\n  return rootNodes.flatMap((rootNode) => {\n    if (!isPresentationHierarchyNode(rootNode)) {\n      return [{ parent: undefined, error: rootNode, expandTo: (expandNode) => expandTo(expandNode, []) }];\n    }\n    if (rootNode.children === true) {\n      return [];\n    }\n    return getErrorNodes(rootNode, !rootNode.isExpanded ? [rootNode.id] : []);\n  });\n}\n\nfunction getErrorNodes(parent: PresentationHierarchyNode, path: string[]) {\n  const errorList: ErrorNode[] = [];\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 (!isPresentationHierarchyNode(node)) {\n      errorList.push({ parent, error: node, expandTo: (expandNode) => expandTo(expandNode, path) });\n      return;\n    }\n\n    if (node.children !== true) {\n      const childErrorList = getErrorNodes(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"]}

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

@@ -14,6 +14,11 @@ export interface LocalizedStrings {
      * Default value: `Apply filter`.
      */
     filterHierarchyLevel: string;
+    /**
+     * Accesible description for applied hierarchy filter button.
+     * Default value: `Filter is applied`.
+     */
+    filterHierarchyLevelActiveDescription: string;
     /**
      * Title for clear hierarchy filter button.
      * Default value: `Clear active filter`.
@@ -21,27 +26,37 @@ export interface LocalizedStrings {
     clearHierarchyLevelFilter: string;
     /**
      * Message displayed when no nodes matching filter are found.
-     * Default value: `No child nodes match current filter`.
+     * 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 result limit exceeds hierarchy size limit.
-     * Default value: `There are more items than allowed limit of {{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 and hierarchy filtering is enabled.
-     * Default value: `Please provide <link>additional filtering</link> - there are more items than allowed limit of {{limit}}.`.
+     * Label displayed on error dropdown.
+     * Default value: `issues found`.
      */
-    resultLimitExceededWithFiltering: string;
+    issuesFound: string;
     /**
      * Message displayed when hierarchy size limit can be overridden.
-     * Default value: `<link>Increase the hierarchy level size limit to {{limit}}.</link>`.
+     * Default value: `Increase limit to {{limit}}`.
      */
     increaseHierarchyLimit: string;
     /**
      * Message displayed when hierarchy size limit can be overridden and hierarchy filtering is enabled.
-     * Default value: `Or, <link>increase the hierarchy level size limit to {{limit}}.</link>`.
+     * Default value: `Add Filter`.
      */
     increaseHierarchyLimitWithFiltering: string;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"LocalizationContext.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/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,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,gCAAgC,EAAE,MAAM,CAAC;IACzC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,mCAAmC,EAAE,MAAM,CAAC;IAC5C;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAgBD;;;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"}
+{"version":3,"file":"LocalizationContext.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/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,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,mCAAmC,EAAE,MAAM,CAAC;IAC5C;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAmBD;;;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/LocalizationContext.js

@@ -7,12 +7,15 @@ 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}}",
+    resultLimitExceeded: "The hierarchy for {{node}} contains {{limit}}+ items. Try using filters or increase the limit",
+    issuesFound: "issues found",
+    increaseHierarchyLimit: "Increase limit to {{limit}}",
+    increaseHierarchyLimitWithFiltering: "Add Filter",
     retry: "Retry",
 };
 const localizationContext = createContext({ localizedStrings: defaultLocalizedStrings });

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

@@ -1 +1 @@
-{"version":3,"file":"LocalizationContext.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/LocalizationContext.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAqB,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA2D1F,MAAM,uBAAuB,GAAqB;IAChD,OAAO,EAAE,YAAY;IACrB,oBAAoB,EAAE,cAAc;IACpC,yBAAyB,EAAE,qBAAqB;IAChD,kBAAkB,EAAE,qCAAqC;IACzD,mBAAmB,EAAE,uDAAuD;IAC5E,gCAAgC,EAAE,0GAA0G;IAC5I,sBAAsB,EAAE,oEAAoE;IAC5F,mCAAmC,EAAE,wEAAwE;IAC7G,KAAK,EAAE,OAAO;CACf,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   * 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 child nodes match current filter`.\n   */\n  noFilteredChildren: string;\n  /**\n   * Message displayed when result limit exceeds hierarchy size limit.\n   * Default value: `There are more items than allowed limit of {{limit}}.`.\n   */\n  resultLimitExceeded: string;\n  /**\n   * Message displayed when result limit exceeds hierarchy size limit and hierarchy filtering is enabled.\n   * Default value: `Please provide <link>additional filtering</link> - there are more items than allowed limit of {{limit}}.`.\n   */\n  resultLimitExceededWithFiltering: string;\n  /**\n   * Message displayed when hierarchy size limit can be overridden.\n   * Default value: `<link>Increase the hierarchy level size limit to {{limit}}.</link>`.\n   */\n  increaseHierarchyLimit: string;\n  /**\n   * Message displayed when hierarchy size limit can be overridden and hierarchy filtering is enabled.\n   * Default value: `Or, <link>increase the hierarchy level size limit to {{limit}}.</link>`.\n   */\n  increaseHierarchyLimitWithFiltering: string;\n  /**\n   * Label for retry action.\n   * Default value: `Retry`.\n   */\n  retry: string;\n}\n\n/** @internal */\nexport interface LocalizationContext {\n  localizedStrings: LocalizedStrings;\n}\n\nconst defaultLocalizedStrings: LocalizedStrings = {\n  loading: \"Loading...\",\n  filterHierarchyLevel: \"Apply filter\",\n  clearHierarchyLevelFilter: \"Clear active filter\",\n  noFilteredChildren: \"No child nodes match current filter\",\n  resultLimitExceeded: \"There are more items than allowed limit of {{limit}}.\",\n  resultLimitExceededWithFiltering: \"Please provide <link>additional filtering</link> - there are more items than allowed limit of {{limit}}.\",\n  increaseHierarchyLimit: \"<link>Increase the hierarchy level size limit to {{limit}}.</link>\",\n  increaseHierarchyLimitWithFiltering: \"Or, <link>increase the hierarchy level size limit to {{limit}}.</link>\",\n  retry: \"Retry\",\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"]}
+{"version":3,"file":"LocalizationContext.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/LocalizationContext.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAqB,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA0E1F,MAAM,uBAAuB,GAAqB;IAChD,OAAO,EAAE,YAAY;IACrB,oBAAoB,EAAE,cAAc;IACpC,qCAAqC,EAAE,mBAAmB;IAC1D,yBAAyB,EAAE,qBAAqB;IAChD,kBAAkB,EAAE,4CAA4C;IAChE,8BAA8B,EAAE,eAAe;IAC/C,uBAAuB,EAAE,yCAAyC;IAClE,mBAAmB,EAAE,+FAA+F;IACpH,WAAW,EAAE,cAAc;IAC3B,sBAAsB,EAAE,6BAA6B;IACrD,mCAAmC,EAAE,YAAY;IACjD,KAAK,EAAE,OAAO;CACf,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   * Accesible 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 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   * Label displayed on error dropdown.\n   * Default value: `issues found`.\n   */\n  issuesFound: 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 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\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  resultLimitExceeded: \"The hierarchy for {{node}} contains {{limit}}+ items. Try using filters or increase the limit\",\n  issuesFound: \"issues found\",\n  increaseHierarchyLimit: \"Increase limit to {{limit}}\",\n  increaseHierarchyLimitWithFiltering: \"Add Filter\",\n  retry: \"Retry\",\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/itwinui/TreeActionButton.d.ts

@@ -0,0 +1,31 @@
+import { PresentationHierarchyNode } from "../TreeNode.js";
+import { HierarchyLevelDetails, useTree } from "../UseTree.js";
+/** @alpha */
+export interface TreeItemAction {
+    label: string;
+    action: () => void;
+    icon: string;
+    /**
+     * Determines action items visibility:
+     * - `False` - action item is hidden.
+     * - `True` - action item is visible at all times.
+     * - `Undefined` - action item is visible on hover/focus.
+     */
+    show?: boolean;
+    /**
+     * Provide a value when action button is in active state to display a dot above the button.
+     * Provided text value is used to set accessible description it should descibe why the action is in active state.
+     * If left undefined the action item will be rendered normally.
+     */
+    activeDescription?: string;
+}
+/** @alpha */
+export type FilterActionProps = {
+    /** Action to perform when the filter button is clicked for this node. */
+    onFilter?: (hierarchyLevelDetails: HierarchyLevelDetails) => void;
+} & Partial<Pick<ReturnType<typeof useTree>, "getHierarchyLevelDetails">>;
+/** @internal */
+export declare function TreeActionButton({ show, label, action, icon, activeDescription }: TreeItemAction): import("react/jsx-runtime").JSX.Element;
+/** @alpha */
+export declare function useFilterAction({ onFilter, getHierarchyLevelDetails }: FilterActionProps): (node: PresentationHierarchyNode) => TreeItemAction;
+//# sourceMappingURL=TreeActionButton.d.ts.map

package/lib/esm/presentation-hierarchies-react/itwinui/TreeActionButton.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeActionButton.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/TreeActionButton.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAK/D,aAAa;AACb,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,aAAa;AACb,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yEAAyE;IACzE,QAAQ,CAAC,EAAE,CAAC,qBAAqB,EAAE,qBAAqB,KAAK,IAAI,CAAC;CACnE,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,OAAO,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC;AAE1E,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,cAAc,2CAEhG;AAED,aAAa;AACb,wBAAgB,eAAe,CAAC,EAAE,QAAQ,EAAE,wBAAwB,EAAE,EAAE,iBAAiB,GAAG,CAAC,IAAI,EAAE,yBAAyB,KAAK,cAAc,CAwB9I"}

package/lib/esm/presentation-hierarchies-react/itwinui/TreeActionButton.js

@@ -0,0 +1,38 @@
+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 { Tree } from "@itwin/itwinui-react/bricks";
+import { useLocalizationContext } from "./LocalizationContext.js";
+const filterSvg = new URL("@itwin/itwinui-icons/filter.svg", import.meta.url).href;
+/** @internal */
+export function TreeActionButton({ show, label, action, icon, activeDescription }) {
+    return _jsx(Tree.ItemAction, { label: label, dot: activeDescription, icon: icon, visible: show, onClick: action });
+}
+/** @alpha */
+export function useFilterAction({ onFilter, getHierarchyLevelDetails }) {
+    const { localizedStrings } = useLocalizationContext();
+    return (node) => {
+        const handleVisibility = () => {
+            if (!onFilter || !node.isFilterable) {
+                return false;
+            }
+            if (node.isFiltered) {
+                return true;
+            }
+            return undefined;
+        };
+        return {
+            label: localizedStrings.filterHierarchyLevel,
+            action: () => {
+                const hierarchyLevelDetails = getHierarchyLevelDetails?.(node.id);
+                hierarchyLevelDetails && onFilter?.(hierarchyLevelDetails);
+            },
+            show: handleVisibility(),
+            activeDescription: node.isFiltered ? localizedStrings.filterHierarchyLevelActiveDescription : undefined,
+            icon: filterSvg,
+        };
+    };
+}
+//# sourceMappingURL=TreeActionButton.js.map

package/lib/esm/presentation-hierarchies-react/itwinui/TreeActionButton.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeActionButton.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/TreeActionButton.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAGnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,iCAAiC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;AA4BnF,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAkB;IAC/F,OAAO,KAAC,IAAI,CAAC,UAAU,IAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,GAAI,CAAC;AAC/G,CAAC;AAED,aAAa;AACb,MAAM,UAAU,eAAe,CAAC,EAAE,QAAQ,EAAE,wBAAwB,EAAqB;IACvF,MAAM,EAAE,gBAAgB,EAAE,GAAG,sBAAsB,EAAE,CAAC;IACtD,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,gBAAgB,GAAG,GAAG,EAAE;YAC5B,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QAEF,OAAO;YACL,KAAK,EAAE,gBAAgB,CAAC,oBAAoB;YAC5C,MAAM,EAAE,GAAG,EAAE;gBACX,MAAM,qBAAqB,GAAG,wBAAwB,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAClE,qBAAqB,IAAI,QAAQ,EAAE,CAAC,qBAAqB,CAAC,CAAC;YAC7D,CAAC;YACD,IAAI,EAAE,gBAAgB,EAAE;YACxB,iBAAiB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,qCAAqC,CAAC,CAAC,CAAC,SAAS;YACvG,IAAI,EAAE,SAAS;SAChB,CAAC;IACJ,CAAC,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 { Tree } from \"@itwin/itwinui-react/bricks\";\nimport { PresentationHierarchyNode } from \"../TreeNode.js\";\nimport { HierarchyLevelDetails, useTree } from \"../UseTree.js\";\nimport { useLocalizationContext } from \"./LocalizationContext.js\";\n\nconst filterSvg = new URL(\"@itwin/itwinui-icons/filter.svg\", import.meta.url).href;\n\n/** @alpha */\nexport interface TreeItemAction {\n  label: string;\n  action: () => void;\n  icon: string;\n  /**\n   * Determines action items visibility:\n   * - `False` - action item is hidden.\n   * - `True` - action item is visible at all times.\n   * - `Undefined` - action item is visible on hover/focus.\n   */\n  show?: boolean;\n  /**\n   * Provide a value when action button is in active state to display a dot above the button.\n   * Provided text value is used to set accessible description it should descibe why the action is in active state.\n   * If left undefined the action item will be rendered normally.\n   */\n  activeDescription?: string;\n}\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} & Partial<Pick<ReturnType<typeof useTree>, \"getHierarchyLevelDetails\">>;\n\n/** @internal */\nexport function TreeActionButton({ show, label, action, icon, activeDescription }: TreeItemAction) {\n  return <Tree.ItemAction label={label} dot={activeDescription} icon={icon} visible={show} onClick={action} />;\n}\n\n/** @alpha */\nexport function useFilterAction({ onFilter, getHierarchyLevelDetails }: FilterActionProps): (node: PresentationHierarchyNode) => TreeItemAction {\n  const { localizedStrings } = useLocalizationContext();\n  return (node) => {\n    const handleVisibility = () => {\n      if (!onFilter || !node.isFilterable) {\n        return false;\n      }\n      if (node.isFiltered) {\n        return true;\n      }\n      return undefined;\n    };\n\n    return {\n      label: localizedStrings.filterHierarchyLevel,\n      action: () => {\n        const hierarchyLevelDetails = getHierarchyLevelDetails?.(node.id);\n        hierarchyLevelDetails && onFilter?.(hierarchyLevelDetails);\n      },\n      show: handleVisibility(),\n      activeDescription: node.isFiltered ? localizedStrings.filterHierarchyLevelActiveDescription : undefined,\n      icon: filterSvg,\n    };\n  };\n}\n"]}

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

@@ -1,12 +1,23 @@
-import { RefAttributes } from "react";
-import { PresentationInfoNode } from "../TreeNode.js";
-import { useTree } from "../UseTree.js";
-import { TreeNodeRendererOwnProps } from "./TreeNodeRenderer.js";
+import { HierarchyLevelDetails, useTree } from "../UseTree.js";
+import { ErrorNode } from "./FlatTreeNode.js";
+/** @alpha */
+export 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;
+}
 interface TreeErrorRendererOwnProps {
-    node: PresentationInfoNode;
+    errorList: ErrorNode[];
+}
+type TreeErrorRendererProps = TreeErrorRendererOwnProps & TreeErrorItemProps & Partial<Pick<ReturnType<typeof useTree>, "getHierarchyLevelDetails">> & Pick<LinkedNodeProps, "scrollToElement">;
+export declare function TreeErrorRenderer({ errorList, scrollToElement, getHierarchyLevelDetails, onFilterClick }: TreeErrorRendererProps): import("react/jsx-runtime").JSX.Element;
+interface LinkedNodeProps {
+    errorNode: ErrorNode;
+    scrollToElement: (node: ErrorNode) => void;
 }
-type TreeErrorRendererProps = TreeErrorRendererOwnProps & Pick<TreeNodeRendererOwnProps, "onFilterClick" | "reloadTree"> & Partial<Pick<ReturnType<typeof useTree>, "getHierarchyLevelDetails">>;
-/** @alpha */
-export declare const TreeErrorRenderer: React.ForwardRefExoticComponent<TreeErrorRendererProps & RefAttributes<HTMLDivElement>>;
 export {};
 //# sourceMappingURL=TreeErrorRenderer.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TreeErrorRenderer.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/TreeErrorRenderer.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAwC,aAAa,EAAE,MAAM,OAAO,CAAC;AAG5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,UAAU,yBAAyB;IACjC,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,KAAK,sBAAsB,GAAG,yBAAyB,GACrD,IAAI,CAAC,wBAAwB,EAAE,eAAe,GAAG,YAAY,CAAC,GAC9D,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,OAAO,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC;AAExE,aAAa;AACb,eAAO,MAAM,iBAAiB,EAAE,KAAK,CAAC,yBAAyB,CAAC,sBAAsB,GAAG,aAAa,CAAC,cAAc,CAAC,CA4BrH,CAAC"}
+{"version":3,"file":"TreeErrorRenderer.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/TreeErrorRenderer.tsx"],"names":[],"mappings":"AAOA,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAG9C,aAAa;AACb,MAAM,WAAW,kBAAkB;IACjC,iGAAiG;IACjG,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC;IACrF,yEAAyE;IACzE,aAAa,CAAC,EAAE,CAAC,qBAAqB,EAAE,qBAAqB,KAAK,IAAI,CAAC;CACxE;AAED,UAAU,yBAAyB;IACjC,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,KAAK,sBAAsB,GAAG,yBAAyB,GACrD,kBAAkB,GAClB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,OAAO,CAAC,EAAE,0BAA0B,CAAC,CAAC,GACrE,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;AAE3C,wBAAgB,iBAAiB,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,wBAAwB,EAAE,aAAa,EAAE,EAAE,sBAAsB,2CA+BhI;AAqDD,UAAU,eAAe;IACvB,SAAS,EAAE,SAAS,CAAC;IACrB,eAAe,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CAC5C"}

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

@@ -3,70 +3,45 @@ 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 { forwardRef } from "react";
-import { Anchor, Text, Tree } from "@itwin/itwinui-react/bricks";
+import { Anchor, unstable_ErrorRegion as ErrorRegion, Text } from "@itwin/itwinui-react/bricks";
 import { MAX_LIMIT_OVERRIDE } from "../internal/Utils.js";
 import { useLocalizationContext } from "./LocalizationContext.js";
-/** @alpha */
-export const TreeErrorRenderer = forwardRef(({ node, getHierarchyLevelDetails, onFilterClick, reloadTree }, forwardedRef) => {
+export function TreeErrorRenderer({ errorList, scrollToElement, getHierarchyLevelDetails, onFilterClick }) {
     const { localizedStrings } = useLocalizationContext();
-    if (node.type === "ResultSetTooLarge") {
-        return (_jsx(ResultSetTooLargeNode, { ref: forwardedRef, limit: node.resultSetSizeLimit, onOverrideLimit: getHierarchyLevelDetails ? (limit) => getHierarchyLevelDetails(node.parentNodeId)?.setSizeLimit(limit) : undefined, onFilterClick: onFilterClick
-                ? () => {
-                    const hierarchyLevelDetails = getHierarchyLevelDetails?.(node.parentNodeId);
-                    hierarchyLevelDetails && onFilterClick(hierarchyLevelDetails);
-                }
-                : undefined }));
-    }
-    if (node.type === "NoFilterMatches") {
-        return _jsx(Tree.Item, { ref: forwardedRef, label: localizedStrings.noFilteredChildren, "aria-disabled": true });
-    }
-    const onRetry = reloadTree ? () => reloadTree({ parentNodeId: node.parentNodeId, state: "reset" }) : undefined;
-    return _jsx(Tree.Item, { ref: forwardedRef, label: _jsx(ErrorNodeLabel, { message: node.message, onRetry: onRetry }), "aria-disabled": true });
-});
-TreeErrorRenderer.displayName = "TreeErrorRenderer";
-const ResultSetTooLargeNode = forwardRef(({ onFilterClick, onOverrideLimit, limit, ...props }, forwardedRef) => {
-    return (_jsx(Tree.Item, { ...props, ref: forwardedRef, className: "stateless-tree-node", label: _jsx(ResultSetTooLargeNodeLabel, { limit: limit, onFilterClick: onFilterClick, onOverrideLimit: onOverrideLimit }) }));
-});
-ResultSetTooLargeNode.displayName = "ResultSetTooLargeNode";
-function ResultSetTooLargeNodeLabel({ onFilterClick, onOverrideLimit, limit }) {
+    const errorItems = errorList.map((errorNode) => {
+        if (errorNode.error.type === "ResultSetTooLarge") {
+            return (_jsx(ResultSetTooLarge, { onFilterClick: () => {
+                    const hierarchyLevelDetails = getHierarchyLevelDetails?.(errorNode.parent?.id);
+                    hierarchyLevelDetails && onFilterClick?.(hierarchyLevelDetails);
+                }, onOverrideLimit: getHierarchyLevelDetails ? (limit) => getHierarchyLevelDetails(errorNode.parent?.id)?.setSizeLimit(limit) : undefined, scrollToElement: scrollToElement, limit: errorNode.error.resultSetSizeLimit, errorNode: errorNode }, errorNode.error.id));
+        }
+        if (errorNode.error.type === "NoFilterMatches") {
+            return _jsx(NoFilterMatches, { scrollToElement: scrollToElement, errorNode: errorNode }, errorNode.error.id);
+        }
+        return _jsx(DefaultErrorContainer, { scrollToElement: scrollToElement, errorNode: errorNode }, errorNode.error.id);
+    });
+    return (_jsx(ErrorRegion.Root, { style: { width: "100%" }, label: errorList.length !== 0 ? `${errorList.length} ${localizedStrings?.issuesFound}` : undefined, items: errorItems }));
+}
+function NoFilterMatches({ onFilterClick, errorNode, scrollToElement }) {
+    const { localizedStrings } = useLocalizationContext();
+    return (_jsx(ErrorRegion.Item, { message: _jsx(MessageWithNode, { errorNode: errorNode, scrollToElement: scrollToElement, message: localizedStrings.noFilteredChildren }), actions: _jsx(Anchor, { onClick: () => onFilterClick, children: localizedStrings.noFilteredChildrenChangeFilter }) }));
+}
+function DefaultErrorContainer({ reloadTree, errorNode, scrollToElement }) {
+    const { localizedStrings } = useLocalizationContext();
+    return (_jsx(ErrorRegion.Item, { message: _jsx(MessageWithNode, { errorNode: errorNode, scrollToElement: scrollToElement, message: localizedStrings.failedToCreateHierarchy }), actions: _jsx(Anchor, { onClick: () => reloadTree, children: localizedStrings.retry }) }));
+}
+function ResultSetTooLarge({ errorNode, onFilterClick, limit, onOverrideLimit, scrollToElement }) {
     const { localizedStrings } = useLocalizationContext();
     const supportsFiltering = !!onFilterClick;
     const supportsLimitOverride = !!onOverrideLimit && limit < MAX_LIMIT_OVERRIDE;
-    const limitExceededMessage = createLocalizedMessage(supportsFiltering ? localizedStrings.resultLimitExceededWithFiltering : localizedStrings.resultLimitExceeded, limit, onFilterClick);
-    const increaseLimitMessage = supportsLimitOverride
-        ? createLocalizedMessage(supportsFiltering ? localizedStrings.increaseHierarchyLimitWithFiltering : localizedStrings.increaseHierarchyLimit, MAX_LIMIT_OVERRIDE, () => onOverrideLimit(MAX_LIMIT_OVERRIDE))
-        : { title: "", element: null };
-    const title = `${limitExceededMessage.title} ${increaseLimitMessage.title}`;
-    return (_jsxs("div", { style: { display: "flex", alignItems: "start" }, title: title, children: [limitExceededMessage.element, increaseLimitMessage.element] }));
+    const messageWithLimit = localizedStrings.resultLimitExceeded.replace("{{limit}}", limit.toString());
+    return (_jsx(ErrorRegion.Item, { message: _jsx(MessageWithNode, { errorNode: errorNode, scrollToElement: scrollToElement, message: messageWithLimit }), actions: _jsxs("div", { style: { display: "flex", flexDirection: "column" }, children: [supportsLimitOverride && (_jsx(Anchor, { onClick: () => onOverrideLimit(MAX_LIMIT_OVERRIDE), children: localizedStrings.increaseHierarchyLimit.replace("{{limit}}", MAX_LIMIT_OVERRIDE.toString()) })), supportsFiltering && _jsx(Anchor, { onClick: onFilterClick, children: localizedStrings.increaseHierarchyLimitWithFiltering })] }) }));
 }
-function ErrorNodeLabel({ message, onRetry }) {
-    const { localizedStrings } = useLocalizationContext();
-    return (_jsxs("div", { style: { display: "flex" }, children: [_jsx(Text, { children: message }), onRetry ? _jsx(Anchor, { onClick: onRetry, children: localizedStrings?.retry }) : null] }));
+function LinkedNode({ errorNode, scrollToElement }) {
+    return _jsx(Anchor, { onClick: () => scrollToElement(errorNode), children: errorNode.parent?.label });
 }
-function createLocalizedMessage(message, limit, onClick) {
-    const limitStr = limit.toLocaleString(undefined, { useGrouping: true });
-    const messageWithLimit = message.replace("{{limit}}", limitStr);
-    const exp = new RegExp("<link>(.*)</link>");
-    const match = messageWithLimit.match(exp);
-    if (!match) {
-        return {
-            title: messageWithLimit,
-            element: (_jsx("div", { style: { display: "flex" }, children: _jsx(Text, { children: messageWithLimit }) })),
-        };
-    }
-    const [fullText, innerText] = match;
-    const [textBefore, textAfter] = messageWithLimit.split(fullText);
-    return {
-        title: messageWithLimit.replace(fullText, innerText),
-        element: (_jsxs("div", { style: { display: "flex" }, children: [textBefore ? _jsx(Text, { children: textBefore }) : null, _jsx(Anchor
-                // underline props does not exist in v5
-                , { 
-                    // underline props does not exist in v5
-                    onClick: (e) => {
-                        e.stopPropagation();
-                        onClick?.();
-                    }, children: innerText }), textAfter ? _jsx(Text, { children: textAfter }) : null] })),
-    };
+function MessageWithNode({ errorNode, scrollToElement, message }) {
+    const splitMessage = message.split("{{node}}", 2);
+    return (_jsxs("div", { style: { display: "flex", whiteSpace: "pre", flexWrap: "wrap" }, children: [_jsx(Text, { variant: "body-sm", children: splitMessage[0] }), _jsx(LinkedNode, { errorNode: errorNode, scrollToElement: scrollToElement }), splitMessage[1] ? _jsx(Text, { variant: "body-sm", children: splitMessage[1] }) : null] }));
 }
 //# sourceMappingURL=TreeErrorRenderer.js.map