useControlledPresentationTreeFiltering Function
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 }
| Parameter | Type | Description |
|---|---|---|
| props | ControlledPresentationTreeFilteringProps |
Returns - { filteredModelSource: TreeModelSource, filteredNodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>, isFiltering: boolean, matchesCount: undefined | number, nodeHighlightingProps: undefined | HighlightableTreeProps }
Defined in
- presentation/components/src/presentation-components/tree/controlled/UseControlledTreeFiltering.ts Line 53
Last Updated: 30 November, 2023