Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tree widget: Add filterButtonsVisibility to TreeRenderer #1178

Merged
merged 2 commits into from
Feb 4, 2025
Merged

Tree widget: Add filterButtonsVisibility to TreeRenderer #1178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fcdca2
Add `filterButtonsVisibility` prop to `TreeRenderer`
grigasp Feb 4, 2025
69d9d6e
change
grigasp Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@itwin-tree-widget-react-a6d91926-a46f-4d4e-a79a-d8249b2c20e4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "Add `filterButtonsVisibility` prop to `TreeRenderer`. The prop allows to control visibility of hierarchy level filtering buttons in the tree: `show-on-hover` (default) shows them on hover or focus, `hide` only shows them when a node is filtered.",
"packageName": "@itwin/tree-widget-react",
"email": "35135765+grigasp@users.noreply.github.com",
"dependentChangeType": "patch"
}
4 changes: 2 additions & 2 deletions packages/itwin/tree-widget/api/tree-widget-react.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,10 +427,10 @@ type TreeProps = Pick<FunctionProps<typeof useIModelTree>, "getFilteredPaths" |
};

// @beta
export function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, isNodeSelected, onFilterClick, getIcon, getLabel, getSublabel, getHierarchyLevelDetails, checkboxProps, reloadTree, size, enableVirtualization, ...props }: TreeRendererProps): JSX.Element;
export function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, isNodeSelected, onFilterClick, getIcon, getLabel, getSublabel, getHierarchyLevelDetails, checkboxProps, filterButtonsVisibility, reloadTree, size, enableVirtualization, ...props }: TreeRendererProps): JSX.Element;

// @beta (undocumented)
type TreeRendererProps = Pick<TreeNodeRendererProps, "expandNode" | "onNodeClick" | "onNodeKeyDown" | "onFilterClick" | "getIcon" | "getLabel" | "getSublabel" | "getHierarchyLevelDetails" | "checkboxProps" | "reloadTree"> & Omit<ComponentPropsWithoutRef<typeof Tree_2<RenderedTreeNode>>, "data" | "nodeRenderer" | "getNode"> & {
type TreeRendererProps = Pick<TreeNodeRendererProps, "expandNode" | "onNodeClick" | "onNodeKeyDown" | "onFilterClick" | "getIcon" | "getLabel" | "getSublabel" | "getHierarchyLevelDetails" | "checkboxProps" | "reloadTree" | "filterButtonsVisibility"> & Omit<ComponentPropsWithoutRef<typeof Tree_2<RenderedTreeNode>>, "data" | "nodeRenderer" | "getNode"> & {
rootNodes: PresentationTreeNode[];
isNodeSelected: (nodeId: string) => boolean;
onNodeDoubleClick?: (node: PresentationHierarchyNode, isSelected: boolean) => void;
Expand Down
2 changes: 1 addition & 1 deletion packages/itwin/tree-widget/src/tree-widget-react/components/trees/common/components/Tree.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export type TreeProps = Pick<FunctionProps<typeof useIModelTree>, "getFilteredPa

/**
* Default tree component that manages tree state and renders using supplied `treeRenderer`.
* @Beta
* @beta
*/
export function Tree({ getSchemaContext, hierarchyLevelSizeLimit, selectionStorage, imodelAccess: providedIModelAccess, ...props }: TreeProps) {
const defaultHierarchyLevelSizeLimit = hierarchyLevelSizeLimit ?? 1000;
Expand Down
4 changes: 4 additions & 0 deletions ...win/tree-widget/src/tree-widget-react/components/trees/common/components/TreeRenderer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export type TreeRendererProps = Pick<
| "getHierarchyLevelDetails"
| "checkboxProps"
| "reloadTree"
| "filterButtonsVisibility"
> &
Omit<ComponentPropsWithoutRef<typeof Tree<RenderedTreeNode>>, "data" | "nodeRenderer" | "getNode"> & {
/** Tree nodes to render. */
Expand Down Expand Up @@ -55,6 +56,7 @@ export function TreeRenderer({
getSublabel,
getHierarchyLevelDetails,
checkboxProps,
filterButtonsVisibility,
reloadTree,
size,
enableVirtualization,
Expand Down Expand Up @@ -85,6 +87,7 @@ export function TreeRenderer({
reloadTree={reloadTree}
className={getSublabel ? "with-description" : "without-description"}
size={size}
filterButtonsVisibility={filterButtonsVisibility}
/>
);
},
Expand All @@ -99,6 +102,7 @@ export function TreeRenderer({
getSublabel,
onFilterClick,
checkboxProps,
filterButtonsVisibility,
reloadTree,
size,
],
Expand Down
Loading