@itwin/presentation-components
Version:
React components based on iTwin.js Presentation library
53 lines • 2.96 kB
TypeScript
/** @packageDocumentation
* @module Tree
*/
import { AbstractTreeNodeLoaderWithProvider, TreeRendererProps } from "@itwin/components-react";
import { IPresentationTreeDataProvider } from "../IPresentationTreeDataProvider.js";
/**
* Props for [[PresentationTreeRenderer]] component.
* @public
* @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).
*/
export interface PresentationTreeRendererProps extends Omit<TreeRendererProps, "nodeRenderer"> {
nodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>;
onFilterApplied?: () => void;
}
/**
* Return type of [[useFilterablePresentationTree]] hook.
* @public
* @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).
*/
export interface FilterableTreeProps {
onFilterClick: (nodeId: string) => void;
onClearFilterClick: (nodeId: string) => void;
filterDialog: React.ReactNode | null;
}
/**
* Props for [[useFilterablePresentationTree]] hook.
* @public
* @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).
*/
export interface useFilterablePresentationTreeProps {
nodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>;
onFilterApplied?: () => void;
}
/**
* Hook that enables hierarchy level filtering with action handlers for setting and clearing filters.
* @public
* @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).
*/
export declare function useFilterablePresentationTree({ nodeLoader, onFilterApplied }: useFilterablePresentationTreeProps): FilterableTreeProps;
/**
* Tree renderer component that enables hierarchy level filtering in trees using [[PresentationTreeDataProvider]].
* It renders tree nodes with action buttons for setting and clearing filters. [[PresentationInstanceFilterDialog]] is opened
* for creating filters for hierarchy levels.
* @public
* @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).
*/
export declare function PresentationTreeRenderer(props: PresentationTreeRendererProps): import("react/jsx-runtime.js").JSX.Element;
//# sourceMappingURL=PresentationTreeRenderer.d.ts.map