useControlledPresentationTreeFiltering Function

Deprecated  in 5.7. All tree-related APIs have been deprecated in favor of the new generation hierarchy

building APIs (see https://github.com/iTwin/presentation/blob/33e79ee8d77f30580a9bab81a72884bda008db25/README.md#the-packages).

A custom hook that creates filtered model source and node loader for supplied filter. If filter string is not provided or filtering is still in progress it returns supplied model source and node loader.

useControlledPresentationTreeFiltering(props: ControlledPresentationTreeFilteringProps): { filteredModelSource: TreeModelSource, filteredNodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>, isFiltering: boolean, matchesCount: undefined | number, nodeHighlightingProps: undefined | HighlightableTreeProps }

Returns - { filteredModelSource: TreeModelSource, filteredNodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>, isFiltering: boolean, matchesCount: undefined | number, nodeHighlightingProps: undefined | HighlightableTreeProps }

Defined in

• packages/components/src/presentation-components/tree/controlled/TreeHooks.ts Line 143