Skip to content

[Tree-widget]: Add option to get a smaller part of models tree #1375

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

Merged
JonasDov merged 18 commits into from
Jul 30, 2025
Merged

[Tree-widget]: Add option to get a smaller part of models tree #1375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
01a7023
Add subsetTree
JonasDov Jul 14, 2025
23a758d
Run extract api and changeset
JonasDov Jul 14, 2025
983de5b
Bump perentation-hierarchies version
JonasDov Jul 16, 2025
bd9bde4
Update package versions
JonasDov Jul 18, 2025
1b06183
Fix merge problems
JonasDov Jul 18, 2025
20666ee
Add back new line
JonasDov Jul 18, 2025
4620661
Merge branch 'master' into JonasD/subset-tree
JonasDov Jul 23, 2025
3a173aa
Change subsetTreeConfig to getSubsetTreePaths
JonasDov Jul 23, 2025
d581905
Merge branch 'master' into JonasD/subset-tree
JonasDov Jul 23, 2025
78944b5
Rename getSubsetTreePaths to getSubTreePaths
JonasDov Jul 23, 2025
dc6a08e
Update name
JonasDov Jul 23, 2025
8629234
Adress comments
JonasDov Jul 24, 2025
b544f6d
Bump hierarchies versions and update comments
JonasDov Jul 24, 2025
82cb2c8
Update packages/itwin/tree-widget/public/locales/en/TreeWidget.json
JonasDov Jul 24, 2025
c2e09d1
Add tests
JonasDov Jul 28, 2025
25e3329
Merge branch 'master' into JonasD/subset-tree
JonasDov Jul 28, 2025
39734ad
Adress comments
JonasDov Jul 28, 2025
b863dd4
Remove wait For
JonasDov Jul 28, 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
2 changes: 1 addition & 1 deletion apps/learning-snippets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"@itwin/presentation-components": "^5.12.4",
"@itwin/presentation-frontend": "^5.0.0",
"@itwin/presentation-testing": "^5.4.5",
"@itwin/presentation-hierarchies": "^1.6.1",
"@itwin/presentation-hierarchies": "^1.7.0",
"@itwin/presentation-shared": "^1.2.2",
"@itwin/unified-selection": "^1.4.2",
"@testing-library/dom": "^10.4.0",
Expand Down
16 changes: 8 additions & 8 deletions apps/learning-snippets/pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion apps/performance-tests/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"@itwin/eslint-plugin": "^5.2.0",
"@itwin/presentation-common": "^5.0.0",
"@itwin/presentation-core-interop": "^1.3.3",
"@itwin/presentation-hierarchies": "^1.6.1",
"@itwin/presentation-hierarchies": "^1.7.0",
"@itwin/presentation-testing": "^5.4.5",
"@itwin/tree-widget-react": "workspace:*",
"@itwin/presentation-shared": "^1.2.2",
Expand Down
16 changes: 8 additions & 8 deletions apps/performance-tests/pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions apps/test-viewer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
"@itwin/presentation-components": "^5.12.4",
"@itwin/presentation-frontend": "^5.0.2",
"@itwin/presentation-testing": "^5.4.5",
"@itwin/presentation-hierarchies": "^1.6.1",
"@itwin/presentation-hierarchies-react": "^1.7.1",
"@itwin/presentation-hierarchies": "^1.7.0",
"@itwin/presentation-hierarchies-react": "^1.7.2",
"@itwin/presentation-shared": "^1.2.2",
"@itwin/property-grid-react": "workspace:*",
"@itwin/reports-config-widget-react": "workspace:*",
Expand Down
26 changes: 13 additions & 13 deletions apps/test-viewer/pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions change/@itwin-tree-widget-react-8f8e08b3-854d-476d-a87b-7e0e2e51f245.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "Added `getSubTreePaths` option to `UseModelsTreeProps` for restricting the visible hierarchy to a sub-tree of nodes based on instance keys. Unlike `getFilteredPaths`, which controls filtering logic, `getSubTreePaths` limits the scope of the hierarchy, allowing filtering within the specified sub-tree.",
"packageName": "@itwin/tree-widget-react",
"email": "100586436+JonasDov@users.noreply.github.com",
"dependentChangeType": "patch"
}
11 changes: 8 additions & 3 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 @@ -9,7 +9,7 @@ import type { ClassGroupingNodeKey } from '@itwin/presentation-hierarchies';
import type { ComponentPropsWithoutRef } from 'react';
import type { ECClassHierarchyInspector } from '@itwin/presentation-shared';
import type { GroupingHierarchyNode } from '@itwin/presentation-hierarchies';
import type { HierarchyFilteringPath } from '@itwin/presentation-hierarchies';
import { HierarchyFilteringPath } from '@itwin/presentation-hierarchies';
import type { HierarchyNode } from '@itwin/presentation-hierarchies-react';
import type { Id64Arg } from '@itwin/core-bentley';
import type { Id64Array } from '@itwin/core-bentley';
Expand Down Expand Up @@ -260,7 +260,7 @@ export const ModelsTreeComponent: {
};

// @public (undocumented)
interface ModelsTreeComponentProps extends Pick<ModelsTreeProps, "getSchemaContext" | "selectionStorage" | "density" | "hierarchyLevelConfig" | "selectionMode" | "selectionPredicate" | "hierarchyConfig" | "visibilityHandlerOverrides" | "getFilteredPaths"> {
interface ModelsTreeComponentProps extends Pick<ModelsTreeProps, "getSchemaContext" | "selectionStorage" | "density" | "hierarchyLevelConfig" | "selectionMode" | "selectionPredicate" | "hierarchyConfig" | "visibilityHandlerOverrides" | "getFilteredPaths" | "getSubTreePaths"> {
headerButtons?: Array<(props: ModelsTreeHeaderButtonProps) => React.ReactNode>;
// (undocumented)
onFeatureUsed?: (feature: string) => void;
Expand Down Expand Up @@ -508,7 +508,7 @@ interface UseCategoriesTreeResult {
export function useFocusedInstancesContext(): FocusedInstancesContext;

// @beta
export function useModelsTree({ activeView, filter, hierarchyConfig, visibilityHandlerOverrides, getFilteredPaths, onModelsFiltered, selectionPredicate: nodeTypeSelectionPredicate, }: UseModelsTreeProps): UseModelsTreeResult;
export function useModelsTree({ activeView, filter, hierarchyConfig, visibilityHandlerOverrides, getFilteredPaths, onModelsFiltered, selectionPredicate: nodeTypeSelectionPredicate, getSubTreePaths, }: UseModelsTreeProps): UseModelsTreeResult;

// @public
export function useModelsTreeButtonProps({ imodel, viewport }: {
Expand All @@ -532,6 +532,11 @@ interface UseModelsTreeProps {
}) => Promise<HierarchyFilteringPath[]>;
filter?: string;
}) => Promise<HierarchyFilteringPath[]>;
getSubTreePaths?: (props: {
createInstanceKeyPaths: (props: {
targetItems: Array<InstanceKey | ElementsGroupInfo>;
}) => Promise<HierarchyFilteringPath[]>;
}) => Promise<HierarchyFilteringPath[]>;
// (undocumented)
hierarchyConfig?: Partial<ModelsTreeHierarchyConfiguration>;
// (undocumented)
Expand Down
4 changes: 2 additions & 2 deletions packages/itwin/tree-widget/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@
"@itwin/itwinui-icons-react": "^2.9.0",
"@itwin/itwinui-illustrations-react": "^2.1.0",
"@itwin/presentation-core-interop": "^1.3.2",
"@itwin/presentation-hierarchies": "^1.6.1",
"@itwin/presentation-hierarchies-react": "^1.7.1",
"@itwin/presentation-hierarchies": "^1.7.0",
"@itwin/presentation-hierarchies-react": "^1.7.2",
"@itwin/presentation-shared": "^1.2.2",
"@itwin/unified-selection": "^1.4.2",
"classnames": "^2.5.1",
Expand Down
24 changes: 12 additions & 12 deletions packages/itwin/tree-widget/pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions packages/itwin/tree-widget/public/locales/en/TreeWidget.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,9 @@
}
}
},
"subTree": {
"unknownSubTreeError": "An unknown error occurred while creating a sub-tree."
},
"filtering": {
"noMatches": "There are no nodes matching filter \"{{filter}}\"",
"unknownFilterError": "An unknown error occurred while filtering the tree.",
Expand Down
Loading
Loading