@itwin/presentation-hierarchies-react 0.1.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"TreeRenderer.js","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/itwinui/TreeRenderer.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAA4B,WAAW,EAAE,MAAM,OAAO,CAAC;AAC9D,OAAO,EAAY,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAiB,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,2BAA2B,EAAoB,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAiBtD;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,SAAS,EACT,UAAU,EACV,WAAW,EACX,cAAc,EACd,aAAa,EACb,OAAO,EACP,WAAW,EACX,wBAAwB,EACxB,aAAa,EACb,gBAAgB,EAChB,GAAG,SAAS,EACM;IAClB,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,mBAAmB,CAAC;QACzD,SAAS;QACT,WAAW,EAAE,WAAW,IAAI,eAAe;QAC3C,aAAa,EAAE,aAAa,IAAI,QAAQ;KACzC,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,SAAS,EAAE,EAAE;QACZ,OAAO,CACL,KAAC,gBAAgB,OACX,SAAS,EACb,UAAU,EAAE,UAAU,EACtB,wBAAwB,EAAE,wBAAwB,EAClD,aAAa,EAAE,aAAa,EAC5B,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,WAAW,GACxB,CACH,CAAC;IACJ,CAAC,EACD,CAAC,UAAU,EAAE,wBAAwB,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,CAAC,CACxG,CAAC;IAEF,MAAM,OAAO,GAAG,WAAW,CAAuB,CAAC,IAAI,EAAE,EAAE,CAAC,0BAA0B,CAAC,IAAI,EAAE,cAAc,IAAI,kBAAkB,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;IAEtJ,OAAO,CACL,KAAC,2BAA2B,IAAC,gBAAgB,EAAE,gBAAgB,YAC7D,KAAC,IAAI,OAAuB,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,IAAI,GAAI,GACxG,CAC/B,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,KAAI,CAAC;AAC7B,SAAS,kBAAkB;IACzB,OAAO,KAAK,CAAC;AACf,CAAC;AAoBD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,0BAA0B,CAAC,IAAsB,EAAE,cAA2C;IAC5G,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,IAAI;YACJ,WAAW,EAAE,KAAK;YAClB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,IAAI;SACjB,CAAC;IACJ,CAAC;IACD,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,EAAE;QACf,IAAI;QACJ,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;QAC/D,QAAQ;QACN,uEAAuE;QACvE,IAAI,CAAC,QAAQ,KAAK,IAAI;YACpB,CAAC,CAAC;gBACE;oBACE,EAAE,EAAE,WAAW,IAAI,CAAC,EAAE,EAAE;oBACxB,YAAY,EAAE,IAAI,CAAC,EAAE;oBACrB,IAAI,EAAE,qBAAqB;iBAC5B;aACF;YACH,CAAC,CAAC,IAAI,CAAC,QAAQ;QACnB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,UAAU,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;KACpC,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 { ComponentPropsWithoutRef, useCallback } from \"react\";\nimport { NodeData, Tree } from \"@itwin/itwinui-react\";\nimport { PresentationTreeNode } from \"../TreeNode\";\nimport { SelectionMode, useSelectionHandler } from \"../UseSelectionHandler\";\nimport { useTree } from \"../UseTree\";\nimport { LocalizationContextProvider, LocalizedStrings } from \"./LocalizationContext\";\nimport { TreeNodeRenderer } from \"./TreeNodeRenderer\";\n\ntype TreeProps = ComponentPropsWithoutRef<typeof Tree<RenderedTreeNode>>;\ntype TreeNodeRendererProps = ComponentPropsWithoutRef<typeof TreeNodeRenderer>;\n\ninterface TreeRendererOwnProps {\n  rootNodes: PresentationTreeNode[];\n  selectionMode?: SelectionMode;\n  localizedStrings?: Partial<LocalizedStrings>;\n}\n\ntype TreeRendererProps = Pick<ReturnType<typeof useTree>, \"rootNodes\" | \"expandNode\"> &\n  Partial<Pick<ReturnType<typeof useTree>, \"selectNodes\" | \"isNodeSelected\" | \"getHierarchyLevelDetails\">> &\n  Pick<TreeNodeRendererProps, \"onFilterClick\" | \"getIcon\" | \"getSublabel\"> &\n  TreeRendererOwnProps &\n  Omit<TreeProps, \"data\" | \"nodeRenderer\" | \"getNode\" | \"enableVirtualization\">;\n\n/**\n * A component that renders a tree using the `Tree` component from `@itwin/itwinui-react`. The tree nodes\n * are rendered using `TreeNodeRenderer` component from this package.\n *\n * @see https://itwinui.bentley.com/docs/tree\n * @beta\n */\nexport function TreeRenderer({\n  rootNodes,\n  expandNode,\n  selectNodes,\n  isNodeSelected,\n  onFilterClick,\n  getIcon,\n  getSublabel,\n  getHierarchyLevelDetails,\n  selectionMode,\n  localizedStrings,\n  ...treeProps\n}: TreeRendererProps) {\n  const { onNodeClick, onNodeKeyDown } = useSelectionHandler({\n    rootNodes,\n    selectNodes: selectNodes ?? noopSelectNodes,\n    selectionMode: selectionMode ?? \"single\",\n  });\n  const nodeRenderer = useCallback<TreeProps[\"nodeRenderer\"]>(\n    (nodeProps) => {\n      return (\n        <TreeNodeRenderer\n          {...nodeProps}\n          expandNode={expandNode}\n          getHierarchyLevelDetails={getHierarchyLevelDetails}\n          onFilterClick={onFilterClick}\n          onNodeClick={onNodeClick}\n          onNodeKeyDown={onNodeKeyDown}\n          getIcon={getIcon}\n          getSublabel={getSublabel}\n        />\n      );\n    },\n    [expandNode, getHierarchyLevelDetails, onFilterClick, onNodeClick, onNodeKeyDown, getIcon, getSublabel],\n  );\n\n  const getNode = useCallback<TreeProps[\"getNode\"]>((node) => createRenderedTreeNodeData(node, isNodeSelected ?? noopIsNodeSelected), [isNodeSelected]);\n\n  return (\n    <LocalizationContextProvider localizedStrings={localizedStrings}>\n      <Tree<RenderedTreeNode> {...treeProps} data={rootNodes} nodeRenderer={nodeRenderer} getNode={getNode} enableVirtualization={true} />\n    </LocalizationContextProvider>\n  );\n}\n\nfunction noopSelectNodes() {}\nfunction noopIsNodeSelected() {\n  return false;\n}\n\n/**\n * A data structure for a tree node that is rendered using the `TreeRenderer` component.\n *\n * In addition to the `PresentationTreeNode` union, this type may have one additional variation - an informational\n * type of node with `ChildrenPlaceholder` type. This type of node is returned as the single child node of a parent\n * while its children are being loaded. This allows the node renderer to show a placeholder under the parent during\n * the process.\n *\n * @beta\n */\nexport type RenderedTreeNode =\n  | PresentationTreeNode\n  | {\n      id: string;\n      parentNodeId: string | undefined;\n      type: \"ChildrenPlaceholder\";\n    };\n\n/**\n * An utility function that creates an `@itwin/itwinui-react` `NodeData` object for the `Tree` component from a\n * `RenderedTreeNode` object.\n *\n * Usage example:\n * ```tsx\n * function MyComponent({ rootNodes, nodeRenderer }: MyComponentProps) {\n *   const getNode = useCallback<TreeProps[\"getNode\"]>((node) => createRenderedTreeNodeData(node, () => false), []);\n *   return <Tree<RenderedTreeNode> data={rootNodes} getNode={getNode} nodeRenderer={nodeRenderer} />;\n * }\n * ```\n *\n * @beta\n */\nexport function createRenderedTreeNodeData(node: RenderedTreeNode, isNodeSelected: (nodeId: string) => boolean): NodeData<RenderedTreeNode> {\n  if (\"type\" in node) {\n    return {\n      nodeId: node.id,\n      node,\n      hasSubNodes: false,\n      isExpanded: false,\n      isSelected: false,\n      isDisabled: true,\n    };\n  }\n  return {\n    nodeId: node.id,\n    node,\n    hasSubNodes: node.children === true || node.children.length > 0,\n    subNodes:\n      // returns placeholder node to show as child while children is loading.\n      node.children === true\n        ? [\n            {\n              id: `Loading-${node.id}`,\n              parentNodeId: node.id,\n              type: \"ChildrenPlaceholder\",\n            },\n          ]\n        : node.children,\n    isExpanded: node.isExpanded,\n    isSelected: isNodeSelected(node.id),\n  };\n}\n"]}

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

@@ -0,0 +1,10 @@
+export { PresentationGenericInfoNode, PresentationHierarchyNode, PresentationInfoNode, PresentationResultSetTooLargeInfoNode, PresentationTreeNode, isPresentationHierarchyNode, } from "./presentation-hierarchies-react/TreeNode";
+export { UnifiedSelectionProvider } from "./presentation-hierarchies-react/UnifiedSelectionContext";
+export { useSelectionHandler } from "./presentation-hierarchies-react/UseSelectionHandler";
+export { HierarchyLevelDetails, useTree, useUnifiedSelectionTree } from "./presentation-hierarchies-react/UseTree";
+export { TreeNodeRenderer } from "./presentation-hierarchies-react/itwinui/TreeNodeRenderer";
+export { RenderedTreeNode, TreeRenderer, createRenderedTreeNodeData } from "./presentation-hierarchies-react/itwinui/TreeRenderer";
+export { LocalizationContextProvider } from "./presentation-hierarchies-react/itwinui/LocalizationContext";
+export { GenericInstanceFilter, HierarchyNode, HierarchyProvider } from "@itwin/presentation-hierarchies";
+export { SelectionStorage } from "@itwin/unified-selection";
+//# sourceMappingURL=presentation-hierarchies-react.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"presentation-hierarchies-react.d.ts","sourceRoot":"","sources":["../../src/presentation-hierarchies-react.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,oBAAoB,EACpB,qCAAqC,EACrC,oBAAoB,EACpB,2BAA2B,GAC5B,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0DAA0D,CAAC;AACpG,OAAO,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAC;AAC3F,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACnH,OAAO,EAAE,gBAAgB,EAAE,MAAM,2DAA2D,CAAC;AAC7F,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,0BAA0B,EAAE,MAAM,uDAAuD,CAAC;AACnI,OAAO,EAAE,2BAA2B,EAAE,MAAM,8DAA8D,CAAC;AAE3G,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAC1G,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC"}

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

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export { isPresentationHierarchyNode, } from "./presentation-hierarchies-react/TreeNode";
+export { UnifiedSelectionProvider } from "./presentation-hierarchies-react/UnifiedSelectionContext";
+export { useSelectionHandler } from "./presentation-hierarchies-react/UseSelectionHandler";
+export { useTree, useUnifiedSelectionTree } from "./presentation-hierarchies-react/UseTree";
+export { TreeNodeRenderer } from "./presentation-hierarchies-react/itwinui/TreeNodeRenderer";
+export { TreeRenderer, createRenderedTreeNodeData } from "./presentation-hierarchies-react/itwinui/TreeRenderer";
+export { LocalizationContextProvider } from "./presentation-hierarchies-react/itwinui/LocalizationContext";
+export { GenericInstanceFilter, HierarchyNode } from "@itwin/presentation-hierarchies";
+//# sourceMappingURL=presentation-hierarchies-react.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"presentation-hierarchies-react.js","sourceRoot":"","sources":["../../src/presentation-hierarchies-react.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAML,2BAA2B,GAC5B,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0DAA0D,CAAC;AACpG,OAAO,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAC;AAC3F,OAAO,EAAyB,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACnH,OAAO,EAAE,gBAAgB,EAAE,MAAM,2DAA2D,CAAC;AAC7F,OAAO,EAAoB,YAAY,EAAE,0BAA0B,EAAE,MAAM,uDAAuD,CAAC;AACnI,OAAO,EAAE,2BAA2B,EAAE,MAAM,8DAA8D,CAAC;AAE3G,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAqB,MAAM,iCAAiC,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\nexport {\n  PresentationGenericInfoNode,\n  PresentationHierarchyNode,\n  PresentationInfoNode,\n  PresentationResultSetTooLargeInfoNode,\n  PresentationTreeNode,\n  isPresentationHierarchyNode,\n} from \"./presentation-hierarchies-react/TreeNode\";\nexport { UnifiedSelectionProvider } from \"./presentation-hierarchies-react/UnifiedSelectionContext\";\nexport { useSelectionHandler } from \"./presentation-hierarchies-react/UseSelectionHandler\";\nexport { HierarchyLevelDetails, useTree, useUnifiedSelectionTree } from \"./presentation-hierarchies-react/UseTree\";\nexport { TreeNodeRenderer } from \"./presentation-hierarchies-react/itwinui/TreeNodeRenderer\";\nexport { RenderedTreeNode, TreeRenderer, createRenderedTreeNodeData } from \"./presentation-hierarchies-react/itwinui/TreeRenderer\";\nexport { LocalizationContextProvider } from \"./presentation-hierarchies-react/itwinui/LocalizationContext\";\n\nexport { GenericInstanceFilter, HierarchyNode, HierarchyProvider } from \"@itwin/presentation-hierarchies\";\nexport { SelectionStorage } from \"@itwin/unified-selection\";\n"]}

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@itwin/presentation-hierarchies-react",
+  "version": "0.1.0",
+  "description": "React components based on `@itwin/presentation-hierarchies`",
+  "license": "MIT",
+  "author": {
+    "name": "Bentley Systems, Inc.",
+    "url": "http://www.bentley.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iTwin/presentation.git",
+    "directory": "packages/hierarchies-react"
+  },
+  "keywords": [
+    "Bentley",
+    "Component",
+    "Components",
+    "EC",
+    "ECSQL",
+    "Hierarchies",
+    "Hierarchy",
+    "iModel",
+    "iTwin",
+    "iTwin.js",
+    "Presentation",
+    "React",
+    "Tree"
+  ],
+  "main": "lib/cjs/presentation-hierarchies-react.js",
+  "module": "lib/esm/presentation-hierarchies-react.js",
+  "types": "lib/cjs/presentation-hierarchies-react.d.ts",
+  "dependencies": {
+    "@itwin/itwinui-icons-react": "^2.8.0",
+    "@itwin/itwinui-illustrations-react": "^2.1.0",
+    "classnames": "^2.5.1",
+    "immer": "^10.0.4",
+    "react-error-boundary": "^4.0.13",
+    "rxjs": "^7.8.1",
+    "@itwin/presentation-hierarchies": "^0.1.0",
+    "@itwin/presentation-shared": "^0.2.0",
+    "@itwin/unified-selection": "^0.4.2"
+  },
+  "peerDependencies": {
+    "@itwin/itwinui-react": "^3.0.0",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@itwin/itwinui-react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@itwin/build-tools": "^4.6.0",
+    "@itwin/itwinui-react": "^3.0.0",
+    "@testing-library/dom": "^9.3.4",
+    "@testing-library/react": "^14.3.1",
+    "@testing-library/user-event": "^14.5.2",
+    "@types/chai": "^4.3.14",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/chai-subset": "^1.3.5",
+    "@types/jsdom": "^21.1.6",
+    "@types/mocha": "^10.0.6",
+    "@types/react": "^18.2.79",
+    "@types/react-dom": "^18.2.25",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^3.2.12",
+    "chai": "^4.4.1",
+    "chai-as-promised": "^7.1.1",
+    "chai-subset": "^1.6.0",
+    "cpx2": "^7.0.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.34.1",
+    "global-jsdom": "^24.0.0",
+    "ignore-styles": "^5.0.1",
+    "jsdom": "^24.0.0",
+    "mocha": "^10.4.0",
+    "nyc": "^15.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rimraf": "^5.0.5",
+    "sinon": "^17.0.1",
+    "sinon-chai": "^3.7.0",
+    "typescript": "~5.4.5",
+    "presentation-test-utilities": "^0.0.0"
+  },
+  "scripts": {
+    "build": "npm run -s build:cjs && npm run -s build:esm",
+    "build:cjs": "npm run -s copy:cjs && tsc -p tsconfig.cjs.json",
+    "build:esm": "npm run -s copy:esm && tsc -p tsconfig.esm.json",
+    "build:watch": "npm run -s build:esm -- -w",
+    "copy:cjs": "cpx \"./src/**/*.{css,json}\" ./lib/cjs",
+    "copy:esm": "cpx \"./src/**/*.{css,json}\" ./lib/esm",
+    "clean": "rimraf lib build",
+    "cover": "nyc npm -s test",
+    "lint": "eslint ./src/**/*.{ts,tsx}",
+    "test": "mocha --enable-source-maps --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\"",
+    "test:watch": "npm -s test -- --reporter min --watch-extensions ts,tsx --watch",
+    "extract-api": "betools extract-api --entry=presentation-hierarchies-react --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
+    "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/presentation-hierarchies-react.api.md"
+  }
+}