New to Telerik UI for Blazor? Download free 30-day trial

TreeView for Navigation

The TreeView can be used to navigate between different pages in the applicaiton. It can generate the needed links for you through its UrlField when data binding.

To use the TreeView for navigating between pages:

  • Add the TreeView to your application.
    • You may want to add it in the MainLayout.razor outside of the @Body, for example, in the sidebar section of your app.
  • Provide a collection of models that describe the pages you want the user to navigate to.
  • Populate its UrlField with the corresponding data from the model or provide a Url property in the model.

Use the TreeView to navigate between pages

@* This a basic example of a TreeView used as Navigation. *@
@* The items that does not have a set Url are not navigation links *@

<TelerikTreeView Data="@TreeViewData"></TelerikTreeView>

@code {
    public List<TreeViewModel> TreeViewData { get; set; }

    protected override void OnInitialized()
    {
        GenerateData();
    }

    public void GenerateData()
    {
        TreeViewData = new List<TreeViewModel>();

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 1,
            Text = "Company",
            ParentId = null,
            HasChildren = true
        });

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 2,
            Text = "Overview",
            ParentId = 1,
            HasChildren = false,
            Url = "/company/overview"
        });

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 3,
            Text = "Contact us",
            ParentId = 1,
            HasChildren = false,
            Url = "/company/contacts"
        });

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 4,
            Text = "Our mission",
            ParentId = 1,
            HasChildren = false,
            Url = "/company/mission"
        });

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 5,
            Text = "Products",
            ParentId = null,
            HasChildren = true
        });

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 6,
            Text = "Core product",
            ParentId = 5,
            HasChildren = true,
            Url = "/producs/core"
        });

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 7,
            Text = "Main product",
            ParentId = 6,
            HasChildren = false,
            Url = "/producs/core/main"
        });

        TreeViewData.Add(new TreeViewModel()
        {
            Id = 8,
            Text = "Other products",
            ParentId = 5,
            HasChildren = false,
            Url = "/producs/other"
        });
    }

    public class TreeViewModel
    {
        public int Id { get; set; }
        public string Text { get; set; }
        public string Url { get; set; }
        public bool HasChildren { get; set; }
        public int? ParentId { get; set; }
    }
}

Notes

  • The UrlField has a default value (Url) and that will be used if present in the model even if you do not define it explicitly.
  • The component uses the NavigationManager from the framework to perform the navigation based on the value from the UrlField.

    • If you have a template that adds anchors, or use a click event to navigate the user yourself, this may lead to double navigation and errors, especially if your model has a field called Url. To avoid such problems, either let the Telerik component do the navigation and remove the application-specific code that does it as well, or remove the URL setting (either rename the model field, or point the UrlField to a non-existing field).

See Also

In this article
Not finding the help you need? Improve this article