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

JonasDov · grigasp · web-flow · commit 5713130092b1 · 2025-06-02T09:36:22.000+03:00
Co-authored-by: Grigas &lt;35135765+grigasp@users.noreply.github.com&gt;
diff --git a/packages/itwin/tree-widget/src/tree-widget-react/components/trees/models-tree/UseModelsTree.tsx b/packages/itwin/tree-widget/src/tree-widget-react/components/trees/models-tree/UseModelsTree.tsx
@@ -35,7 +35,7 @@ type ModelsTreeFilteringError = "tooManyFilterMatches" | "tooManyInstancesFocuse
 /** @beta */
 export interface UseModelsTreeProps {
   /**
-   * Optional search string used to filter tree nodes.
+   * Optional search string used to filter tree nodes by label, as well as highlight matching substrings in the tree.
    * Nodes that do not contain this string in their label will be filtered out.
    *
    * If `getFilteredPaths` function is provided, it will take precedence and automatic filtering by this string will not be applied.

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ type ModelsTreeFilteringError = "tooManyFilterMatches" \| "tooManyInstancesFocuse`
`35`	`35`	`/** @beta */`
`36`	`36`	`export interface UseModelsTreeProps {`
`37`	`37`	`/**`
`38`		`- * Optional search string used to filter tree nodes.`
	`38`	`+ * Optional search string used to filter tree nodes by label, as well as highlight matching substrings in the tree.`
`39`	`39`	`* Nodes that do not contain this string in their label will be filtered out.`
`40`	`40`	`*`
`41`	`41`	* If `getFilteredPaths` function is provided, it will take precedence and automatic filtering by this string will not be applied.