Skip to content

Docs: Tree example #19624

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.

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Docs: Tree example #19624

wants to merge 13 commits into from

Conversation

madsrasmussen
Copy link
Contributor

This PR adds a basic "Tree Example" to the examples folder.

The examples include:

  • Tree + Tree Item Registration
  • Tree Repository + Store Registration
  • A Dashboard to show how to render a tree anywhere in the backoffice
  • How to use the tree in the sidebar menu
Screenshot 2025-06-27 at 15 01 40

@madsrasmussen madsrasmussen changed the title V16/feature/tree example Docs: Tree example Jun 27, 2025
@madsrasmussen madsrasmussen marked this pull request as ready for review June 27, 2025 13:03
@Copilot Copilot AI review requested due to automatic review settings June 27, 2025 13:03
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a basic "Tree Example" demonstrating how to register a tree, implement its associated repository and store, and integrate a dashboard and sidebar menu to render the tree in the backoffice. Key changes include:

  • New TypeScript interfaces to define tree item and root models.
  • Implementation of tree store, repository, and local data source functionality.
  • Addition of manifests and a dashboard element to integrate the tree with the backoffice and menu.

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/Umbraco.Web.UI.Client/examples/tree/tree/types.ts Defines tree item and tree root models.
src/Umbraco.Web.UI.Client/examples/tree/tree/manifests.ts Registers tree and tree item manifests with proper entity types.
src/Umbraco.Web.UI.Client/examples/tree/tree/data/store/*.ts Introduces tree store, context token, and corresponding manifests.
src/Umbraco.Web.UI.Client/examples/tree/tree/data/repository/*.ts Implements a tree repository using a local data source.
src/Umbraco.Web.UI.Client/examples/tree/tree/data/local-data-source/tree.local.data-source.ts Provides a local data source with methods to retrieve root items, children, and ancestors.
src/Umbraco.Web.UI.Client/examples/tree/dashboard-with-tree/*.ts Adds a dashboard element and manifest for visual rendering of the tree.
Remaining files Set up necessary constants, entities, and index exports to integrate the example.

@madsrasmussen madsrasmussen requested a review from leekelleher July 4, 2025 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant