Skip to content

Commit bef37f5

Browse files
JonasDovgrigasp
andauthored
Update packages/itwin/tree-widget/src/tree-widget-react/components/trees/models-tree/UseModelsTree.tsx
Co-authored-by: Grigas <35135765+grigasp@users.noreply.github.com>
1 parent 7b78aea commit bef37f5

File tree

1 file changed

+4
-3
lines changed
  • packages/itwin/tree-widget/src/tree-widget-react/components/trees/models-tree

1 file changed

+4
-3
lines changed

packages/itwin/tree-widget/src/tree-widget-react/components/trees/models-tree/UseModelsTree.tsx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,11 @@ export interface UseModelsTreeProps {
5454
* - `createInstanceKeyPaths`: Helper function to create filter paths.
5555
* - `filter`: The filter string which would otherwise be used for default filtering.
5656
*
57-
* ### Example use cases:
58-
* - You have a list of `InstanceKey` items, which you want to keep. Pass them as `targetItems` to `createInstanceKeyPaths`.
59-
* - You want to create filter paths based on a label, but also apply some extra conditions (for example exclude paths with sub-models).
57+
* **Example use cases:**
58+
* - You have a list of `InstanceKey` items, which you want to use for filtering the hierarchy.
59+
* - You want to create filter paths based on node label, but also apply some extra conditions (for example exclude paths with sub-models).
6060
* - You want to construct custom filtered paths. For example: create a filter path for each geometric element which has a parent element.
61+
*
6162
* @note Paths returned by `createInstanceKeyPaths` will not have `autoExpand` flag set. If you want nodes to be expanded, iterate over the paths and
6263
* set `autoExpand: true` manually.
6364
*/

0 commit comments

Comments
 (0)