@itwin/tree-widget-react 2.3.2 → 3.0.0-dev.1

package/lib/cjs/components/trees/VisibilityTreeRenderer.js

@@ -1,98 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VisibilityTreeNoFilteredData = exports.useVisibilityTreeFiltering = exports.FilterableVisibilityTreeNodeRenderer = exports.VisibilityTreeNodeCheckbox = exports.createVisibilityTreeNodeRenderer = exports.createVisibilityTreeRenderer = void 0;
-const jsx_runtime_1 = require("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.
- *--------------------------------------------------------------------------------------------*/
-const classnames_1 = __importDefault(require("classnames"));
-const react_1 = require("react");
-const components_react_1 = require("@itwin/components-react");
-const itwinui_react_1 = require("@itwin/itwinui-react");
-const presentation_components_1 = require("@itwin/presentation-components");
-const TreeRenderer_1 = require("./common/TreeRenderer");
-/**
- * These constants are taken from `@itwin/core-react`.
- * Defines the size in pixels of the expansion toggle.
- * It is used to keep same hierarchy nodes with children and nodes without children in the same line.
- * @note This value applies only to the leaf nodes.
- */
-const EXPANSION_TOGGLE_WIDTH = 24;
-const EXPANDED_EXPANSION_TOGGLE_WIDTH = 42;
-const imageLoader = new components_react_1.TreeImageLoader();
-/**
- * Creates Visibility tree renderer which renders nodes with eye checkbox.
- * @public
- */
-function createVisibilityTreeRenderer({ nodeRendererProps, ...restProps }) {
-    return function VisibilityTreeRenderer(treeProps) {
-        return (0, jsx_runtime_1.jsx)(TreeRenderer_1.TreeRenderer, { ...treeProps, ...restProps, nodeRenderer: createVisibilityTreeNodeRenderer(nodeRendererProps) });
-    };
-}
-exports.createVisibilityTreeRenderer = createVisibilityTreeRenderer;
-/**
- * Creates node renderer which renders node with eye checkbox.
- * @public
- */
-function createVisibilityTreeNodeRenderer({ levelOffset = 20, disableRootNodeCollapse = false, descriptionEnabled, iconsEnabled, onVisibilityToggled, }) {
-    return function VisibilityTreeNodeRenderer(treeNodeProps) {
-        const nodeOffset = treeNodeProps.node.depth * levelOffset + (treeNodeProps.node.numChildren === 0 ? EXPANSION_TOGGLE_WIDTH : 0);
-        return ((0, jsx_runtime_1.jsx)(components_react_1.TreeNodeRenderer, { ...treeNodeProps, node: { ...treeNodeProps.node, depth: 0, numChildren: 1 }, checkboxRenderer: (checkboxProps) => ((0, jsx_runtime_1.jsx)("div", { className: "visibility-tree-checkbox-container", style: { marginRight: `${nodeOffset}px` }, children: (0, jsx_runtime_1.jsx)(VisibilityTreeNodeCheckbox, { ...checkboxProps, onVisibilityToggled: onVisibilityToggled }) })), descriptionEnabled: descriptionEnabled, imageLoader: iconsEnabled ? imageLoader : undefined, className: (0, classnames_1.default)("with-checkbox", (treeNodeProps.node.numChildren === 0 || (disableRootNodeCollapse && treeNodeProps.node.parentId === undefined)) && "disable-expander", treeNodeProps.className) }));
-    };
-}
-exports.createVisibilityTreeNodeRenderer = createVisibilityTreeNodeRenderer;
-/**
- * Checkbox renderer that renders an eye.
- * @public
- */
-function VisibilityTreeNodeCheckbox(props) {
-    return ((0, jsx_runtime_1.jsx)(itwinui_react_1.Checkbox, { className: "visibility-tree-checkbox", variant: "eyeball", checked: props.checked, onChange: (e) => {
-            props.onVisibilityToggled?.(e.currentTarget.checked);
-            props.onChange(e.currentTarget.checked);
-        }, onMouseDown: (e) => e.stopPropagation(), onClick: props.onClick, disabled: props.disabled, title: props.title }));
-}
-exports.VisibilityTreeNodeCheckbox = VisibilityTreeNodeCheckbox;
-/**
- * Creates node renderer which renders node with eye checkbox and hierarchy level filtering actions.
- * @beta
- */
-function FilterableVisibilityTreeNodeRenderer({ levelOffset = 20, disableRootNodeCollapse, descriptionEnabled, isEnlarged, onVisibilityToggled, ...restProps }) {
-    const expansionToggleWidth = isEnlarged ? EXPANDED_EXPANSION_TOGGLE_WIDTH : EXPANSION_TOGGLE_WIDTH;
-    const nodeOffset = restProps.node.depth * levelOffset + (restProps.node.numChildren === 0 ? expansionToggleWidth : 0);
-    return ((0, jsx_runtime_1.jsx)(presentation_components_1.PresentationTreeNodeRenderer, { ...restProps, checkboxRenderer: (checkboxProps) => ((0, jsx_runtime_1.jsx)("div", { className: "visibility-tree-checkbox-container", style: { marginRight: `${nodeOffset}px` }, children: (0, jsx_runtime_1.jsx)(VisibilityTreeNodeCheckbox, { ...checkboxProps, onVisibilityToggled: onVisibilityToggled }) })), descriptionEnabled: descriptionEnabled, imageLoader: imageLoader, className: (0, classnames_1.default)("with-checkbox", (restProps.node.numChildren === 0 || (disableRootNodeCollapse && restProps.node.parentId === undefined)) && "disable-expander") }));
-}
-exports.FilterableVisibilityTreeNodeRenderer = FilterableVisibilityTreeNodeRenderer;
-/**
- * Filters data provider used in supplied node loader and invokes onFilterApplied when filtering is completed.
- * @public
- * @deprecated in 2.0.0. Use [[useVisibilityTree]] instead.
- */
-// istanbul ignore next
-function useVisibilityTreeFiltering(nodeLoader, filterInfo, onFilterApplied) {
-    const { filter, activeMatchIndex } = filterInfo ?? { filter: undefined, activeMatchIndex: undefined };
-    const { filteredNodeLoader, isFiltering, matchesCount, nodeHighlightingProps } = (0, presentation_components_1.useControlledPresentationTreeFiltering)({
-        nodeLoader,
-        filter,
-        activeMatchIndex,
-    });
-    (0, react_1.useEffect)(() => {
-        if (filter && matchesCount !== undefined && filteredNodeLoader !== nodeLoader) {
-            onFilterApplied && onFilterApplied(filteredNodeLoader.dataProvider, matchesCount);
-        }
-    }, [filter, matchesCount, nodeLoader, filteredNodeLoader, onFilterApplied]);
-    return { filteredNodeLoader, isFiltering, nodeHighlightingProps };
-}
-exports.useVisibilityTreeFiltering = useVisibilityTreeFiltering;
-/**
- * Renders message that no nodes was found for filter.
- * @public
- */
-function VisibilityTreeNoFilteredData(props) {
-    return ((0, jsx_runtime_1.jsxs)("div", { className: "components-tree-errormessage", children: [(0, jsx_runtime_1.jsx)("span", { className: "errormessage-header", children: props.title }), (0, jsx_runtime_1.jsx)("span", { className: "errormessage-body", children: props.message })] }));
-}
-exports.VisibilityTreeNoFilteredData = VisibilityTreeNoFilteredData;
-//# sourceMappingURL=VisibilityTreeRenderer.js.map

package/lib/cjs/components/trees/VisibilityTreeRenderer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"VisibilityTreeRenderer.js","sourceRoot":"","sources":["../../../../src/components/trees/VisibilityTreeRenderer.tsx"],"names":[],"mappings":";;;;;;;AAAA;;;gGAGgG;AAEhG,4DAAoC;AACpC,iCAAkC;AAClC,8DAA4E;AAC5E,wDAAgD;AAChD,4EAAsH;AACtH,wDAAqD;AAOrD;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAE3C,MAAM,WAAW,GAAG,IAAI,kCAAe,EAAE,CAAC;AA6C1C;;;GAGG;AACH,SAAgB,4BAA4B,CAAC,EAAE,iBAAiB,EAAE,GAAG,SAAS,EAA+B;IAC3G,OAAO,SAAS,sBAAsB,CAAC,SAA4B;QACjE,OAAO,uBAAC,2BAAY,OAAK,SAAS,KAAM,SAAS,EAAE,YAAY,EAAE,gCAAgC,CAAC,iBAAiB,CAAC,GAAI,CAAC;IAC3H,CAAC,CAAC;AACJ,CAAC;AAJD,oEAIC;AAED;;;GAGG;AACH,SAAgB,gCAAgC,CAAC,EAC/C,WAAW,GAAG,EAAE,EAChB,uBAAuB,GAAG,KAAK,EAC/B,kBAAkB,EAClB,YAAY,EACZ,mBAAmB,GACa;IAChC,OAAO,SAAS,0BAA0B,CAAC,aAAoC;QAC7E,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,GAAG,WAAW,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChI,OAAO,CACL,uBAAC,mCAAgB,OACX,aAAa,EACjB,IAAI,EAAE,EAAE,GAAG,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,EACzD,gBAAgB,EAAE,CAAC,aAAsC,EAAE,EAAE,CAAC,CAC5D,gCAAK,SAAS,EAAC,oCAAoC,EAAC,KAAK,EAAE,EAAE,WAAW,EAAE,GAAG,UAAU,IAAI,EAAE,YAC3F,uBAAC,0BAA0B,OAAK,aAAa,EAAE,mBAAmB,EAAE,mBAAmB,GAAI,GACvF,CACP,EACD,kBAAkB,EAAE,kBAAkB,EACtC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,EACnD,SAAS,EAAE,IAAA,oBAAU,EACnB,eAAe,EACf,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,IAAI,CAAC,uBAAuB,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,IAAI,kBAAkB,EACtI,aAAa,CAAC,SAAS,CACxB,GACD,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA5BD,4EA4BC;AAMD;;;GAGG;AACH,SAAgB,0BAA0B,CAAC,KAAsC;IAC/E,OAAO,CACL,uBAAC,wBAAQ,IACP,SAAS,EAAC,0BAA0B,EACpC,OAAO,EAAC,SAAS,EACjB,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;YACd,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACrD,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC1C,CAAC,EACD,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,EACvC,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,KAAK,EAAE,KAAK,CAAC,KAAK,GAClB,CACH,CAAC;AACJ,CAAC;AAhBD,gEAgBC;AAQD;;;GAGG;AACH,SAAgB,oCAAoC,CAAC,EACnD,WAAW,GAAG,EAAE,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,UAAU,EACV,mBAAmB,EACnB,GAAG,SAAS,EAC8B;IAC1C,MAAM,oBAAoB,GAAG,UAAU,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,sBAAsB,CAAC;IACnG,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,GAAG,WAAW,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtH,OAAO,CACL,uBAAC,sDAA4B,OACvB,SAAS,EACb,gBAAgB,EAAE,CAAC,aAAsC,EAAE,EAAE,CAAC,CAC5D,gCAAK,SAAS,EAAC,oCAAoC,EAAC,KAAK,EAAE,EAAE,WAAW,EAAE,GAAG,UAAU,IAAI,EAAE,YAC3F,uBAAC,0BAA0B,OAAK,aAAa,EAAE,mBAAmB,EAAE,mBAAmB,GAAI,GACvF,CACP,EACD,kBAAkB,EAAE,kBAAkB,EACtC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,IAAA,oBAAU,EACnB,eAAe,EACf,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,IAAI,CAAC,uBAAuB,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,IAAI,kBAAkB,CAC/H,GACD,CACH,CAAC;AACJ,CAAC;AA3BD,oFA2BC;AAED;;;;GAIG;AACH,uBAAuB;AACvB,SAAgB,0BAA0B,CACxC,UAA6E,EAC7E,UAAqC,EACrC,eAAqG;IAErG,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,UAAU,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC;IACtG,MAAM,EAAE,kBAAkB,EAAE,WAAW,EAAE,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAA,gEAAsC,EAAC;QACtH,UAAU;QACV,MAAM;QACN,gBAAgB;KACjB,CAAC,CAAC;IAEH,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,IAAI,MAAM,IAAI,YAAY,KAAK,SAAS,IAAI,kBAAkB,KAAK,UAAU,EAAE;YAC7E,eAAe,IAAI,eAAe,CAAC,kBAAkB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;SACnF;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAC,CAAC;IAE5E,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,qBAAqB,EAAE,CAAC;AACpE,CAAC;AAnBD,gEAmBC;AAWD;;;GAGG;AACH,SAAgB,4BAA4B,CAAC,KAAwC;IACnF,OAAO,CACL,iCAAK,SAAS,EAAC,8BAA8B,aAC3C,iCAAM,SAAS,EAAC,qBAAqB,YAAE,KAAK,CAAC,KAAK,GAAQ,EAC1D,iCAAM,SAAS,EAAC,mBAAmB,YAAE,KAAK,CAAC,OAAO,GAAQ,IACtD,CACP,CAAC;AACJ,CAAC;AAPD,oEAOC","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 classNames from \"classnames\";\nimport { useEffect } from \"react\";\nimport { TreeImageLoader, TreeNodeRenderer } from \"@itwin/components-react\";\nimport { Checkbox } from \"@itwin/itwinui-react\";\nimport { PresentationTreeNodeRenderer, useControlledPresentationTreeFiltering } from \"@itwin/presentation-components\";\nimport { TreeRenderer } from \"./common/TreeRenderer\";\n\nimport type { NodeCheckboxRenderProps } from \"@itwin/core-react\";\nimport type { TreeRendererBaseProps, TreeRendererProps } from \"./common/TreeRenderer\";\nimport type { AbstractTreeNodeLoaderWithProvider, TreeNodeRendererProps } from \"@itwin/components-react\";\nimport type { IPresentationTreeDataProvider, PresentationTreeNodeRendererProps } from \"@itwin/presentation-components\";\nimport type { VisibilityTreeFilterInfo } from \"./common/Types\";\n/**\n * These constants are taken from `@itwin/core-react`.\n * Defines the size in pixels of the expansion toggle.\n * It is used to keep same hierarchy nodes with children and nodes without children in the same line.\n * @note This value applies only to the leaf nodes.\n */\nconst EXPANSION_TOGGLE_WIDTH = 24;\nconst EXPANDED_EXPANSION_TOGGLE_WIDTH = 42;\n\nconst imageLoader = new TreeImageLoader();\n\n/**\n * Props for visibility tree renderer.\n * @public\n */\nexport interface VisibilityTreeRendererProps extends TreeRendererBaseProps {\n  /** Props for single node renderer. */\n  nodeRendererProps: VisibilityTreeNodeRendererProps;\n}\n\n/**\n * Props for visibility tree node renderer.\n * @public\n */\nexport interface VisibilityTreeNodeRendererProps {\n  /**\n   * Specifies whether the icon at the left of the node label should be rendered.\n   */\n  iconsEnabled: boolean;\n  /**\n   * Specifies whether node description should be enabled.\n   */\n  descriptionEnabled: boolean;\n  /**\n   * Defines the offset in pixels of how much each hierarchy level should be offset to the right from the checkbox.\n   * Defaults to `20`.\n   */\n  levelOffset?: number;\n  /**\n   * Specifies whether the root node be expanded at all times.\n   * Defaults to `false`.\n   */\n  disableRootNodeCollapse?: boolean;\n  /**\n   * Specifies whether the nodes should be enlarged (less dense and larger content).\n   * Is `false` by default\n   */\n  isEnlarged?: boolean;\n  /**\n   * Callback called when visibility is toggled using a checkbox.\n   */\n  onVisibilityToggled?: (enabled: boolean) => void;\n}\n\n/**\n * Creates Visibility tree renderer which renders nodes with eye checkbox.\n * @public\n */\nexport function createVisibilityTreeRenderer({ nodeRendererProps, ...restProps }: VisibilityTreeRendererProps) {\n  return function VisibilityTreeRenderer(treeProps: TreeRendererProps) {\n    return <TreeRenderer {...treeProps} {...restProps} nodeRenderer={createVisibilityTreeNodeRenderer(nodeRendererProps)} />;\n  };\n}\n\n/**\n * Creates node renderer which renders node with eye checkbox.\n * @public\n */\nexport function createVisibilityTreeNodeRenderer({\n  levelOffset = 20,\n  disableRootNodeCollapse = false,\n  descriptionEnabled,\n  iconsEnabled,\n  onVisibilityToggled,\n}: VisibilityTreeNodeRendererProps) {\n  return function VisibilityTreeNodeRenderer(treeNodeProps: TreeNodeRendererProps) {\n    const nodeOffset = treeNodeProps.node.depth * levelOffset + (treeNodeProps.node.numChildren === 0 ? EXPANSION_TOGGLE_WIDTH : 0);\n    return (\n      <TreeNodeRenderer\n        {...treeNodeProps}\n        node={{ ...treeNodeProps.node, depth: 0, numChildren: 1 }} // if we want to disable TreeNodeRenderer style calculations for tree nodes, we need to override these values.\n        checkboxRenderer={(checkboxProps: NodeCheckboxRenderProps) => (\n          <div className=\"visibility-tree-checkbox-container\" style={{ marginRight: `${nodeOffset}px` }}>\n            <VisibilityTreeNodeCheckbox {...checkboxProps} onVisibilityToggled={onVisibilityToggled} />\n          </div>\n        )}\n        descriptionEnabled={descriptionEnabled}\n        imageLoader={iconsEnabled ? imageLoader : undefined}\n        className={classNames(\n          \"with-checkbox\",\n          (treeNodeProps.node.numChildren === 0 || (disableRootNodeCollapse && treeNodeProps.node.parentId === undefined)) && \"disable-expander\",\n          treeNodeProps.className,\n        )}\n      />\n    );\n  };\n}\n\ninterface VisibilityTreeNodeCheckboxProps extends NodeCheckboxRenderProps {\n  onVisibilityToggled?: (enabled: boolean) => void;\n}\n\n/**\n * Checkbox renderer that renders an eye.\n * @public\n */\nexport function VisibilityTreeNodeCheckbox(props: VisibilityTreeNodeCheckboxProps) {\n  return (\n    <Checkbox\n      className=\"visibility-tree-checkbox\"\n      variant=\"eyeball\"\n      checked={props.checked}\n      onChange={(e) => {\n        props.onVisibilityToggled?.(e.currentTarget.checked);\n        props.onChange(e.currentTarget.checked);\n      }}\n      onMouseDown={(e) => e.stopPropagation()}\n      onClick={props.onClick}\n      disabled={props.disabled}\n      title={props.title}\n    />\n  );\n}\n\n/**\n * Props for [[FilterableVisibilityTreeNodeRenderer]].\n * @beta\n */\nexport type FilterableVisibilityTreeNodeRendererProps = Omit<PresentationTreeNodeRendererProps, \"descriptionEnabled\"> & VisibilityTreeNodeRendererProps;\n\n/**\n * Creates node renderer which renders node with eye checkbox and hierarchy level filtering actions.\n * @beta\n */\nexport function FilterableVisibilityTreeNodeRenderer({\n  levelOffset = 20,\n  disableRootNodeCollapse,\n  descriptionEnabled,\n  isEnlarged,\n  onVisibilityToggled,\n  ...restProps\n}: FilterableVisibilityTreeNodeRendererProps) {\n  const expansionToggleWidth = isEnlarged ? EXPANDED_EXPANSION_TOGGLE_WIDTH : EXPANSION_TOGGLE_WIDTH;\n  const nodeOffset = restProps.node.depth * levelOffset + (restProps.node.numChildren === 0 ? expansionToggleWidth : 0);\n\n  return (\n    <PresentationTreeNodeRenderer\n      {...restProps}\n      checkboxRenderer={(checkboxProps: NodeCheckboxRenderProps) => (\n        <div className=\"visibility-tree-checkbox-container\" style={{ marginRight: `${nodeOffset}px` }}>\n          <VisibilityTreeNodeCheckbox {...checkboxProps} onVisibilityToggled={onVisibilityToggled} />\n        </div>\n      )}\n      descriptionEnabled={descriptionEnabled}\n      imageLoader={imageLoader}\n      className={classNames(\n        \"with-checkbox\",\n        (restProps.node.numChildren === 0 || (disableRootNodeCollapse && restProps.node.parentId === undefined)) && \"disable-expander\",\n      )}\n    />\n  );\n}\n\n/**\n * Filters data provider used in supplied node loader and invokes onFilterApplied when filtering is completed.\n * @public\n * @deprecated in 2.0.0. Use [[useVisibilityTree]] instead.\n */\n// istanbul ignore next\nexport function useVisibilityTreeFiltering(\n  nodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>,\n  filterInfo?: VisibilityTreeFilterInfo,\n  onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void,\n) {\n  const { filter, activeMatchIndex } = filterInfo ?? { filter: undefined, activeMatchIndex: undefined };\n  const { filteredNodeLoader, isFiltering, matchesCount, nodeHighlightingProps } = useControlledPresentationTreeFiltering({\n    nodeLoader,\n    filter,\n    activeMatchIndex,\n  });\n\n  useEffect(() => {\n    if (filter && matchesCount !== undefined && filteredNodeLoader !== nodeLoader) {\n      onFilterApplied && onFilterApplied(filteredNodeLoader.dataProvider, matchesCount);\n    }\n  }, [filter, matchesCount, nodeLoader, filteredNodeLoader, onFilterApplied]);\n\n  return { filteredNodeLoader, isFiltering, nodeHighlightingProps };\n}\n\n/**\n * Properties for [[VisibilityTreeNoFilteredData]] component.\n * @public\n */\nexport interface VisibilityTreeNoFilteredDataProps {\n  title: string;\n  message: string;\n}\n\n/**\n * Renders message that no nodes was found for filter.\n * @public\n */\nexport function VisibilityTreeNoFilteredData(props: VisibilityTreeNoFilteredDataProps) {\n  return (\n    <div className=\"components-tree-errormessage\">\n      <span className=\"errormessage-header\">{props.title}</span>\n      <span className=\"errormessage-body\">{props.message}</span>\n    </div>\n  );\n}\n"]}

package/lib/cjs/components/trees/category-tree/Categories.json

@@ -1,99 +0,0 @@
-{
-  "$schema": "../../../../node_modules/@itwin/presentation-common/Ruleset.schema.json",
-  "id": "tree-widget-react/CategoriesTree",
-  "rules": [
-    {
-      "ruleType": "RootNodes",
-      "subConditions": [
-        {
-          "condition": "GetVariableStringValue(\"ViewType\") = \"3d\"",
-          "specifications": [
-            {
-              "specType": "InstanceNodesOfSpecificClasses",
-              "classes": [
-                {
-                  "schemaName": "BisCore",
-                  "classNames": ["SpatialCategory"],
-                  "arePolymorphic": true
-                }
-              ],
-              "relatedInstances": [
-                {
-                  "relationshipPath": {
-                    "relationship": {
-                      "schemaName": "BisCore",
-                      "className": "ModelContainsElements"
-                    },
-                    "direction": "Backward"
-                  },
-                  "isRequired": true,
-                  "alias": "model"
-                }
-              ],
-              "instanceFilter": "NOT this.IsPrivate AND (NOT model.IsPrivate OR model.IsOfClass(\"DictionaryModel\", \"BisCore\")) AND this.HasRelatedInstance(\"BisCore:GeometricElement3dIsInCategory\", \"Backward\", \"BisCore:Element\")",
-              "groupByClass": false,
-              "groupByLabel": false
-            }
-          ]
-        },
-        {
-          "condition": "GetVariableStringValue(\"ViewType\") = \"2d\"",
-          "specifications": [
-            {
-              "specType": "InstanceNodesOfSpecificClasses",
-              "classes": [
-                {
-                  "schemaName": "BisCore",
-                  "classNames": ["DrawingCategory"],
-                  "arePolymorphic": true
-                }
-              ],
-              "relatedInstances": [
-                {
-                  "relationshipPath": {
-                    "relationship": {
-                      "schemaName": "BisCore",
-                      "className": "ModelContainsElements"
-                    },
-                    "direction": "Backward"
-                  },
-                  "isRequired": true,
-                  "alias": "model"
-                }
-              ],
-              "instanceFilter": "NOT this.IsPrivate AND (NOT model.IsPrivate OR model.IsOfClass(\"DictionaryModel\", \"BisCore\")) AND this.HasRelatedInstance(\"BisCore:GeometricElement2dIsInCategory\", \"Backward\", \"BisCore:Element\")",
-              "groupByClass": false,
-              "groupByLabel": false
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "ruleType": "ChildNodes",
-      "condition": "ParentNode.IsOfClass(\"Category\", \"BisCore\") ANDALSO ParentNode.ECInstance.GetRelatedInstancesCount(\"BisCore:CategoryOwnsSubCategories\", \"Forward\", \"BisCore:SubCategory\") > 1",
-      "specifications": [
-        {
-          "specType": "RelatedInstanceNodes",
-          "relationshipPaths": [
-            {
-              "relationship": {
-                "schemaName": "BisCore",
-                "className": "CategoryOwnsSubCategories"
-              },
-              "direction": "Forward"
-            }
-          ],
-          "instanceFilter": "NOT this.IsPrivate",
-          "groupByClass": false,
-          "groupByLabel": false
-        }
-      ]
-    },
-    {
-      "ruleType": "LabelOverride",
-      "condition": "this.IsOfClass(\"Category\", \"BisCore\")",
-      "description": "this.Description"
-    }
-  ]
-}

package/lib/cjs/components/trees/category-tree/CategoriesTree.d.ts

@@ -1,60 +0,0 @@
-/// <reference types="react" />
-import "../VisibilityTreeBase.scss";
-import { CategoryVisibilityHandler } from "./CategoryVisibilityHandler";
-import type { ViewManager, Viewport } from "@itwin/core-frontend";
-import type { Ruleset } from "@itwin/presentation-common";
-import type { BaseFilterableTreeProps, HierarchyLevelConfig } from "../common/Types";
-import type { CategoryInfo } from "./CategoryVisibilityHandler";
-/**
- * Presentation rules used by ControlledCategoriesTree
- * @internal
- */
-export declare const RULESET_CATEGORIES: Ruleset;
-/**
- * Properties for the [[CategoryTree]] component
- * @public
- */
-export interface CategoryTreeProps extends BaseFilterableTreeProps {
-    /** Flag for accommodating all viewports */
-    allViewports?: boolean;
-    /** Active viewport */
-    activeView: Viewport;
-    /**
-     * Available iModel categories
-     */
-    categories: CategoryInfo[];
-    /**
-     * Custom category visibility handler to use for testing
-     * @internal
-     */
-    categoryVisibilityHandler?: CategoryVisibilityHandler;
-    /**
-     * Custom view manager to use for testing
-     * @internal
-     */
-    viewManager?: ViewManager;
-    /**
-     * Props for configuring hierarchy level.
-     * @beta
-     */
-    hierarchyLevelConfig?: HierarchyLevelConfig;
-    /**
-     * Callback that is invoked when performance of tracked feature is measured.
-     * @param featureId ID of the feature.
-     * @param elapsedTime Elapsed time of the feature.
-     * @beta
-     */
-    onPerformanceMeasured?: (featureId: string, elapsedTime: number) => void;
-    /**
-     * Callback that is invoked when a tracked feature is used.
-     * @param featureId ID of the feature.
-     * @beta
-     */
-    onFeatureUsed?: (feature: string) => void;
-}
-/**
- * Tree which displays and manages display of categories contained in an iModel.
- * @public
- */
-export declare function CategoryTree(props: CategoryTreeProps): JSX.Element | null;
-//# sourceMappingURL=CategoriesTree.d.ts.map

package/lib/cjs/components/trees/category-tree/CategoriesTree.js

@@ -1,141 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CategoryTree = exports.RULESET_CATEGORIES = void 0;
-const jsx_runtime_1 = require("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.
- *--------------------------------------------------------------------------------------------*/
-require("../VisibilityTreeBase.scss");
-const classnames_1 = __importDefault(require("classnames"));
-const react_1 = require("react");
-const components_react_1 = require("@itwin/components-react");
-const core_frontend_1 = require("@itwin/core-frontend");
-const presentation_components_1 = require("@itwin/presentation-components");
-const presentation_frontend_1 = require("@itwin/presentation-frontend");
-const TreeWidget_1 = require("../../../TreeWidget");
-const TreeRenderer_1 = require("../common/TreeRenderer");
-const UseFeatureReporting_1 = require("../common/UseFeatureReporting");
-const UsePerformanceReporting_1 = require("../common/UsePerformanceReporting");
-const UseVisibilityTreeState_1 = require("../common/UseVisibilityTreeState");
-const Utils_1 = require("../common/Utils");
-const VisibilityTreeRenderer_1 = require("../VisibilityTreeRenderer");
-const RULESET_CATEGORIES_IMPORT = __importStar(require("./Categories.json"));
-const CategoriesTreeComponent_1 = require("./CategoriesTreeComponent");
-const CategoryVisibilityHandler_1 = require("./CategoryVisibilityHandler");
-const PAGING_SIZE = 20;
-/**
- * Presentation rules used by ControlledCategoriesTree
- * @internal
- */
-exports.RULESET_CATEGORIES = RULESET_CATEGORIES_IMPORT;
-/**
- * Tree which displays and manages display of categories contained in an iModel.
- * @public
- */
-function CategoryTree(props) {
-    // istanbul ignore next
-    const viewManager = props.viewManager ?? core_frontend_1.IModelApp.viewManager;
-    const { activeView, allViewports, categoryVisibilityHandler, onFilterApplied, density, hierarchyLevelConfig, onPerformanceMeasured, onFeatureUsed } = props;
-    const visibilityHandler = useCategoryVisibilityHandler(viewManager, props.iModel, props.categories, activeView, allViewports, categoryVisibilityHandler);
-    const onFilterChange = (0, react_1.useCallback)((dataProvider, matchesCount) => {
-        if (onFilterApplied && dataProvider && matchesCount !== undefined) {
-            onFilterApplied(dataProvider, matchesCount);
-        }
-    }, [onFilterApplied]);
-    const { reportUsage } = (0, UseFeatureReporting_1.useFeatureReporting)({ treeIdentifier: CategoriesTreeComponent_1.CategoriesTreeComponent.id, onFeatureUsed });
-    const { onNodeLoaded } = (0, UsePerformanceReporting_1.usePerformanceReporting)({
-        treeIdentifier: CategoriesTreeComponent_1.CategoriesTreeComponent.id,
-        onPerformanceMeasured,
-    });
-    const state = (0, UseVisibilityTreeState_1.useVisibilityTreeState)({
-        imodel: props.iModel,
-        ruleset: exports.RULESET_CATEGORIES,
-        pagingSize: PAGING_SIZE,
-        visibilityHandler,
-        customizeTreeNodeItem,
-        filterInfo: props.filterInfo,
-        onFilterChange,
-        hierarchyLevelSizeLimit: hierarchyLevelConfig?.sizeLimit,
-        enableHierarchyAutoUpdate: true,
-        onNodeLoaded,
-        reportUsage,
-    });
-    (0, react_1.useEffect)(() => {
-        setViewType(activeView); // eslint-disable-line @typescript-eslint/no-floating-promises
-    }, [activeView]);
-    const baseRendererProps = {
-        reportUsage,
-        contextMenuItems: props.contextMenuItems,
-        nodeLabelRenderer: props.nodeLabelRenderer,
-        density: props.density,
-        nodeRendererProps: {
-            iconsEnabled: false,
-            descriptionEnabled: true,
-            levelOffset: 10,
-            onVisibilityToggled: () => reportUsage({ featureId: "visibility-change", reportInteraction: true }),
-        },
-    };
-    const noFilteredDataRenderer = (0, react_1.useCallback)(() => {
-        return ((0, jsx_runtime_1.jsx)(VisibilityTreeRenderer_1.VisibilityTreeNoFilteredData, { title: TreeWidget_1.TreeWidget.translate("categoriesTree.noCategoryFound"), message: TreeWidget_1.TreeWidget.translate("categoriesTree.noMatchingCategoryNames") }));
-    }, []);
-    if (!state) {
-        return null;
-    }
-    const isFilterApplied = state.filteringResult?.filteredProvider !== undefined;
-    const overlay = state.filteringResult?.isFiltering ? (0, jsx_runtime_1.jsx)("div", { className: "filteredTreeOverlay" }) : undefined;
-    return ((0, jsx_runtime_1.jsxs)("div", { className: (0, classnames_1.default)("tree-widget-visibility-tree-base", "tree-widget-tree-container"), children: [(0, jsx_runtime_1.jsx)(presentation_components_1.PresentationTree, { width: props.width, height: props.height, state: state, selectionMode: props.selectionMode ?? components_react_1.SelectionMode.None, treeRenderer: hierarchyLevelConfig?.isFilteringEnabled
-                    ? (rendererProps) => ((0, jsx_runtime_1.jsx)(TreeRenderer_1.FilterableTreeRenderer, { ...rendererProps, ...baseRendererProps, nodeLoader: state.nodeLoader, nodeRenderer: (nodeProps) => (0, jsx_runtime_1.jsx)(CategoriesTreeNodeRenderer, { ...nodeProps, density: density }) }))
-                    : (0, VisibilityTreeRenderer_1.createVisibilityTreeRenderer)(baseRendererProps), descriptionsEnabled: true, noDataRenderer: isFilterApplied ? noFilteredDataRenderer : undefined }), overlay] }));
-}
-exports.CategoryTree = CategoryTree;
-function CategoriesTreeNodeRenderer(props) {
-    return ((0, jsx_runtime_1.jsx)(VisibilityTreeRenderer_1.FilterableVisibilityTreeNodeRenderer, { ...props, iconsEnabled: false, descriptionEnabled: true, levelOffset: 10, isEnlarged: props.density === "enlarged", onVisibilityToggled: () => props.reportUsage?.({ featureId: "visibility-change", reportInteraction: true }) }));
-}
-function useCategoryVisibilityHandler(viewManager, imodel, categories, activeView, allViewports, visibilityHandler) {
-    const [state, setState] = (0, react_1.useState)();
-    (0, react_1.useEffect)(() => {
-        if (visibilityHandler) {
-            return;
-        }
-        const defaultHandler = new CategoryVisibilityHandler_1.CategoryVisibilityHandler({ viewManager, imodel, categories, activeView, allViewports });
-        setState(defaultHandler);
-        return () => {
-            defaultHandler.dispose();
-        };
-    }, [viewManager, imodel, categories, activeView, allViewports, visibilityHandler]);
-    return visibilityHandler ?? state;
-}
-async function setViewType(activeView) {
-    const view = activeView.view;
-    const viewType = view.is3d() ? "3d" : "2d";
-    await presentation_frontend_1.Presentation.presentation.vars(exports.RULESET_CATEGORIES.id).setString("ViewType", viewType);
-}
-const customizeTreeNodeItem = (0, Utils_1.combineTreeNodeItemCustomizations)([Utils_1.addCustomTreeNodeItemLabelRenderer]);
-//# sourceMappingURL=CategoriesTree.js.map

package/lib/cjs/components/trees/category-tree/CategoriesTree.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CategoriesTree.js","sourceRoot":"","sources":["../../../../../src/components/trees/category-tree/CategoriesTree.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;gGAGgG;AAEhG,sCAAoC;AACpC,4DAAoC;AACpC,iCAAyD;AACzD,8DAAwD;AACxD,wDAAiD;AACjD,4EAAkE;AAClE,wEAA4D;AAC5D,oDAAiD;AACjD,yDAAgE;AAChE,uEAAoE;AACpE,+EAA4E;AAC5E,6EAA0E;AAC1E,2CAAwG;AACxG,sEAA6I;AAC7I,6EAA+D;AAC/D,uEAAoE;AACpE,2EAAwE;AAQxE,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB;;;GAGG;AACU,QAAA,kBAAkB,GAAG,yBAAoC,CAAC;AA6CvE;;;GAGG;AACH,SAAgB,YAAY,CAAC,KAAwB;IACnD,uBAAuB;IACvB,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,yBAAS,CAAC,WAAW,CAAC;IAC/D,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,yBAAyB,EAAE,eAAe,EAAE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IAE5J,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,yBAAyB,CAAC,CAAC;IACzJ,MAAM,cAAc,GAAG,IAAA,mBAAW,EAChC,CAAC,YAAoD,EAAE,YAAqB,EAAE,EAAE;QAC9E,IAAI,eAAe,IAAI,YAAY,IAAI,YAAY,KAAK,SAAS,EAAE;YACjE,eAAe,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;SAC7C;IACH,CAAC,EACD,CAAC,eAAe,CAAC,CAClB,CAAC;IAEF,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,yCAAmB,EAAC,EAAE,cAAc,EAAE,iDAAuB,CAAC,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;IAC3G,MAAM,EAAE,YAAY,EAAE,GAAG,IAAA,iDAAuB,EAAC;QAC/C,cAAc,EAAE,iDAAuB,CAAC,EAAE;QAC1C,qBAAqB;KACtB,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,IAAA,+CAAsB,EAAC;QACnC,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,0BAAkB;QAC3B,UAAU,EAAE,WAAW;QACvB,iBAAiB;QACjB,qBAAqB;QACrB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,cAAc;QACd,uBAAuB,EAAE,oBAAoB,EAAE,SAAS;QACxD,yBAAyB,EAAE,IAAI;QAC/B,YAAY;QACZ,WAAW;KACZ,CAAC,CAAC;IAEH,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,8DAA8D;IACzF,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB,MAAM,iBAAiB,GAAG;QACxB,WAAW;QACX,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;QACxC,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;QAC1C,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,iBAAiB,EAAE;YACjB,YAAY,EAAE,KAAK;YACnB,kBAAkB,EAAE,IAAI;YACxB,WAAW,EAAE,EAAE;YACf,mBAAmB,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;SACpG;KACF,CAAC;IAEF,MAAM,sBAAsB,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;QAC9C,OAAO,CACL,uBAAC,qDAA4B,IAC3B,KAAK,EAAE,uBAAU,CAAC,SAAS,CAAC,gCAAgC,CAAC,EAC7D,OAAO,EAAE,uBAAU,CAAC,SAAS,CAAC,wCAAwC,CAAC,GACvE,CACH,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,IAAI,CAAC;KACb;IAED,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,EAAE,gBAAgB,KAAK,SAAS,CAAC;IAC9E,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC,gCAAK,SAAS,EAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACzG,OAAO,CACL,iCAAK,SAAS,EAAE,IAAA,oBAAU,EAAC,kCAAkC,EAAE,4BAA4B,CAAC,aAC1F,uBAAC,0CAAgB,IACf,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,EACpB,KAAK,EAAE,KAAK,EACZ,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,gCAAa,CAAC,IAAI,EACxD,YAAY,EACV,oBAAoB,EAAE,kBAAkB;oBACtC,CAAC,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CACjB,uBAAC,qCAAsB,OACjB,aAAa,KACb,iBAAiB,EACrB,UAAU,EAAE,KAAK,CAAC,UAAU,EAC5B,YAAY,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,uBAAC,0BAA0B,OAAK,SAAS,EAAE,OAAO,EAAE,OAAO,GAAI,GAC5F,CACH;oBACH,CAAC,CAAC,IAAA,qDAA4B,EAAC,iBAAiB,CAAC,EAErD,mBAAmB,EAAE,IAAI,EACzB,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,GACpE,EACD,OAAO,IACJ,CACP,CAAC;AACJ,CAAC;AA5FD,oCA4FC;AAMD,SAAS,0BAA0B,CAAC,KAAsC;IACxE,OAAO,CACL,uBAAC,6DAAoC,OAC/B,KAAK,EACT,YAAY,EAAE,KAAK,EACnB,kBAAkB,EAAE,IAAI,EACxB,WAAW,EAAE,EAAE,EACf,UAAU,EAAE,KAAK,CAAC,OAAO,KAAK,UAAU,EACxC,mBAAmB,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,GAC3G,CACH,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CACnC,WAAwB,EACxB,MAAwB,EACxB,UAA0B,EAC1B,UAAoB,EACpB,YAAsB,EACtB,iBAA6C;IAE7C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAA,gBAAQ,GAA6B,CAAC;IAEhE,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,IAAI,iBAAiB,EAAE;YACrB,OAAO;SACR;QAED,MAAM,cAAc,GAAG,IAAI,qDAAyB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QACpH,QAAQ,CAAC,cAAc,CAAC,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEnF,OAAO,iBAAiB,IAAI,KAAK,CAAC;AACpC,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,UAAoB;IAC7C,MAAM,IAAI,GAAG,UAAU,CAAC,IAAwB,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3C,MAAM,oCAAY,CAAC,YAAY,CAAC,IAAI,CAAC,0BAAkB,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAC9F,CAAC;AAED,MAAM,qBAAqB,GAAG,IAAA,yCAAiC,EAAC,CAAC,0CAAkC,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 \"../VisibilityTreeBase.scss\";\nimport classNames from \"classnames\";\nimport { useCallback, useEffect, useState } from \"react\";\nimport { SelectionMode } from \"@itwin/components-react\";\nimport { IModelApp } from \"@itwin/core-frontend\";\nimport { PresentationTree } from \"@itwin/presentation-components\";\nimport { Presentation } from \"@itwin/presentation-frontend\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { FilterableTreeRenderer } from \"../common/TreeRenderer\";\nimport { useFeatureReporting } from \"../common/UseFeatureReporting\";\nimport { usePerformanceReporting } from \"../common/UsePerformanceReporting\";\nimport { useVisibilityTreeState } from \"../common/UseVisibilityTreeState\";\nimport { addCustomTreeNodeItemLabelRenderer, combineTreeNodeItemCustomizations } from \"../common/Utils\";\nimport { createVisibilityTreeRenderer, FilterableVisibilityTreeNodeRenderer, VisibilityTreeNoFilteredData } from \"../VisibilityTreeRenderer\";\nimport * as RULESET_CATEGORIES_IMPORT from \"./Categories.json\";\nimport { CategoriesTreeComponent } from \"./CategoriesTreeComponent\";\nimport { CategoryVisibilityHandler } from \"./CategoryVisibilityHandler\";\n\nimport type { FilterableTreeNodeRendererProps } from \"../common/TreeRenderer\";\nimport type { IModelConnection, SpatialViewState, ViewManager, Viewport } from \"@itwin/core-frontend\";\nimport type { Ruleset } from \"@itwin/presentation-common\";\nimport type { IFilteredPresentationTreeDataProvider } from \"@itwin/presentation-components\";\nimport type { BaseFilterableTreeProps, HierarchyLevelConfig } from \"../common/Types\";\nimport type { CategoryInfo } from \"./CategoryVisibilityHandler\";\nconst PAGING_SIZE = 20;\n\n/**\n * Presentation rules used by ControlledCategoriesTree\n * @internal\n */\nexport const RULESET_CATEGORIES = RULESET_CATEGORIES_IMPORT as Ruleset;\n\n/**\n * Properties for the [[CategoryTree]] component\n * @public\n */\nexport interface CategoryTreeProps extends BaseFilterableTreeProps {\n  /** Flag for accommodating all viewports */\n  allViewports?: boolean;\n  /** Active viewport */\n  activeView: Viewport;\n  /**\n   * Available iModel categories\n   */\n  categories: CategoryInfo[];\n  /**\n   * Custom category visibility handler to use for testing\n   * @internal\n   */\n  categoryVisibilityHandler?: CategoryVisibilityHandler;\n  /**\n   * Custom view manager to use for testing\n   * @internal\n   */\n  viewManager?: ViewManager;\n  /**\n   * Props for configuring hierarchy level.\n   * @beta\n   */\n  hierarchyLevelConfig?: HierarchyLevelConfig;\n  /**\n   * Callback that is invoked when performance of tracked feature is measured.\n   * @param featureId ID of the feature.\n   * @param elapsedTime Elapsed time of the feature.\n   * @beta\n   */\n  onPerformanceMeasured?: (featureId: string, elapsedTime: number) => void;\n  /**\n   * Callback that is invoked when a tracked feature is used.\n   * @param featureId ID of the feature.\n   * @beta\n   */\n  onFeatureUsed?: (feature: string) => void;\n}\n\n/**\n * Tree which displays and manages display of categories contained in an iModel.\n * @public\n */\nexport function CategoryTree(props: CategoryTreeProps) {\n  // istanbul ignore next\n  const viewManager = props.viewManager ?? IModelApp.viewManager;\n  const { activeView, allViewports, categoryVisibilityHandler, onFilterApplied, density, hierarchyLevelConfig, onPerformanceMeasured, onFeatureUsed } = props;\n\n  const visibilityHandler = useCategoryVisibilityHandler(viewManager, props.iModel, props.categories, activeView, allViewports, categoryVisibilityHandler);\n  const onFilterChange = useCallback(\n    (dataProvider?: IFilteredPresentationTreeDataProvider, matchesCount?: number) => {\n      if (onFilterApplied && dataProvider && matchesCount !== undefined) {\n        onFilterApplied(dataProvider, matchesCount);\n      }\n    },\n    [onFilterApplied],\n  );\n\n  const { reportUsage } = useFeatureReporting({ treeIdentifier: CategoriesTreeComponent.id, onFeatureUsed });\n  const { onNodeLoaded } = usePerformanceReporting({\n    treeIdentifier: CategoriesTreeComponent.id,\n    onPerformanceMeasured,\n  });\n\n  const state = useVisibilityTreeState({\n    imodel: props.iModel,\n    ruleset: RULESET_CATEGORIES,\n    pagingSize: PAGING_SIZE,\n    visibilityHandler,\n    customizeTreeNodeItem,\n    filterInfo: props.filterInfo,\n    onFilterChange,\n    hierarchyLevelSizeLimit: hierarchyLevelConfig?.sizeLimit,\n    enableHierarchyAutoUpdate: true,\n    onNodeLoaded,\n    reportUsage,\n  });\n\n  useEffect(() => {\n    setViewType(activeView); // eslint-disable-line @typescript-eslint/no-floating-promises\n  }, [activeView]);\n\n  const baseRendererProps = {\n    reportUsage,\n    contextMenuItems: props.contextMenuItems,\n    nodeLabelRenderer: props.nodeLabelRenderer,\n    density: props.density,\n    nodeRendererProps: {\n      iconsEnabled: false,\n      descriptionEnabled: true,\n      levelOffset: 10,\n      onVisibilityToggled: () => reportUsage({ featureId: \"visibility-change\", reportInteraction: true }),\n    },\n  };\n\n  const noFilteredDataRenderer = useCallback(() => {\n    return (\n      <VisibilityTreeNoFilteredData\n        title={TreeWidget.translate(\"categoriesTree.noCategoryFound\")}\n        message={TreeWidget.translate(\"categoriesTree.noMatchingCategoryNames\")}\n      />\n    );\n  }, []);\n\n  if (!state) {\n    return null;\n  }\n\n  const isFilterApplied = state.filteringResult?.filteredProvider !== undefined;\n  const overlay = state.filteringResult?.isFiltering ? <div className=\"filteredTreeOverlay\" /> : undefined;\n  return (\n    <div className={classNames(\"tree-widget-visibility-tree-base\", \"tree-widget-tree-container\")}>\n      <PresentationTree\n        width={props.width}\n        height={props.height}\n        state={state}\n        selectionMode={props.selectionMode ?? SelectionMode.None}\n        treeRenderer={\n          hierarchyLevelConfig?.isFilteringEnabled\n            ? (rendererProps) => (\n                <FilterableTreeRenderer\n                  {...rendererProps}\n                  {...baseRendererProps}\n                  nodeLoader={state.nodeLoader}\n                  nodeRenderer={(nodeProps) => <CategoriesTreeNodeRenderer {...nodeProps} density={density} />}\n                />\n              )\n            : createVisibilityTreeRenderer(baseRendererProps)\n        }\n        descriptionsEnabled={true}\n        noDataRenderer={isFilterApplied ? noFilteredDataRenderer : undefined}\n      />\n      {overlay}\n    </div>\n  );\n}\n\ninterface CategoriesTreeNodeRendererProps extends FilterableTreeNodeRendererProps {\n  density?: \"default\" | \"enlarged\";\n}\n\nfunction CategoriesTreeNodeRenderer(props: CategoriesTreeNodeRendererProps) {\n  return (\n    <FilterableVisibilityTreeNodeRenderer\n      {...props}\n      iconsEnabled={false}\n      descriptionEnabled={true}\n      levelOffset={10}\n      isEnlarged={props.density === \"enlarged\"}\n      onVisibilityToggled={() => props.reportUsage?.({ featureId: \"visibility-change\", reportInteraction: true })}\n    />\n  );\n}\n\nfunction useCategoryVisibilityHandler(\n  viewManager: ViewManager,\n  imodel: IModelConnection,\n  categories: CategoryInfo[],\n  activeView: Viewport,\n  allViewports?: boolean,\n  visibilityHandler?: CategoryVisibilityHandler,\n) {\n  const [state, setState] = useState<CategoryVisibilityHandler>();\n\n  useEffect(() => {\n    if (visibilityHandler) {\n      return;\n    }\n\n    const defaultHandler = new CategoryVisibilityHandler({ viewManager, imodel, categories, activeView, allViewports });\n    setState(defaultHandler);\n    return () => {\n      defaultHandler.dispose();\n    };\n  }, [viewManager, imodel, categories, activeView, allViewports, visibilityHandler]);\n\n  return visibilityHandler ?? state;\n}\n\nasync function setViewType(activeView: Viewport) {\n  const view = activeView.view as SpatialViewState;\n  const viewType = view.is3d() ? \"3d\" : \"2d\";\n  await Presentation.presentation.vars(RULESET_CATEGORIES.id).setString(\"ViewType\", viewType);\n}\n\nconst customizeTreeNodeItem = combineTreeNodeItemCustomizations([addCustomTreeNodeItemLabelRenderer]);\n"]}

package/lib/cjs/components/trees/category-tree/CategoriesTreeComponent.d.ts

@@ -1,71 +0,0 @@
-/// <reference types="react" />
-import "../VisibilityTreeBase.scss";
-import type { TreeHeaderButtonProps } from "../../tree-header/TreeHeader";
-import type { CategoryTreeProps } from "./CategoriesTree";
-import type { CategoryInfo } from "./CategoryVisibilityHandler";
-/**
- * Props that get passed to [[CategoriesTreeComponent]] header button renderer.
- * @see CategoriesTreeComponentProps.headerButtons
- * @public
- */
-export interface CategoriesTreeHeaderButtonProps extends TreeHeaderButtonProps {
-    /** A list of categories available in the iModel */
-    categories: CategoryInfo[];
-    /** In case the tree is filtered, a list of filtered categories. */
-    filteredCategories?: CategoryInfo[];
-}
-/**
- * Props for [[CategoriesTreeComponent]].
- * @public
- */
-export interface CategoriesTreeComponentProps extends Omit<CategoryTreeProps, "iModel" | "activeView" | "width" | "height" | "filterInfo" | "onFilterApplied" | "categories" | "categoryVisibilityHandler" | "viewManager"> {
-    /**
-     * Renderers of header buttons. Defaults to:
-     * ```ts
-     * [
-     *   CategoriesTreeComponent.ShowAllButton,
-     *   CategoriesTreeComponent.HideAllButton,
-     *   CategoriesTreeComponent.InvertAllButton,
-     * ]
-     * ```
-     */
-    headerButtons?: Array<(props: CategoriesTreeHeaderButtonProps) => React.ReactNode>;
-}
-/**
- * A component that renders [[CategoriesTree]] and a header with filtering capabilities
- * and header buttons.
- * @public
- */
-export declare const CategoriesTreeComponent: {
-    (props: CategoriesTreeComponentProps): JSX.Element | null;
-    /**
-     * Renders a "Show all" button that enables display of all categories and their subcategories.
-     * @public
-     */
-    ShowAllButton: typeof ShowAllButton;
-    /**
-     * Renders a "Hide all" button that disables display of all categories.
-     * @public
-     */
-    HideAllButton: typeof HideAllButton;
-    /**
-     * Renders an "Invert all" button that inverts display of all categories.
-     * @public
-     */
-    InvertAllButton: typeof InvertAllButton;
-    /**
-     * Id of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
-     * @public
-     */
-    id: string;
-    /**
-     * Label of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
-     * @public
-     */
-    getLabel(): string;
-};
-declare function ShowAllButton(props: CategoriesTreeHeaderButtonProps): JSX.Element;
-declare function HideAllButton(props: CategoriesTreeHeaderButtonProps): JSX.Element;
-declare function InvertAllButton(props: CategoriesTreeHeaderButtonProps): JSX.Element;
-export {};
-//# sourceMappingURL=CategoriesTreeComponent.d.ts.map