Documentation versions (currently viewingVaadin 23)

You are viewing documentation for Vaadin 23. View latest documentation

Navigating between Views in Vaadin

Learn to set up a parent layout and navigate between child views.

So far in this tutorial series, you’ve built a Customer Relationship Management (CRM) application for listing and editing contacts. In this chapter, you add a dashboard view to the application. You also add a responsive application layout, with a header and a navigation sidebar that can be toggled on small screens.

Application layout with a header and a sidebar

Defining View Routes

You can make any Vaadin component a navigation target by adding an @Route("<path>") annotation. Routes can be nested by defining the parent layout in the annotation: @Route(value = "list", layout=MainLayout.class).

Creating the Parent Layout

The application should have:

  • a shared parent layout with two child views:

    MainLayout: App Layout with header and navigation:

    1. ListView: the default view, mapped to "".

    2. DashboardView: mapped to "dashboard".

  • a responsive application layout and navigation links.

Begin by creating a new Java class named MainLayout in the views package with the following content. This is the shared parent layout of both views in the application.

package com.example.application.views;

import com.example.application.views.list.ListView;
import com.vaadin.flow.component.applayout.AppLayout;
import com.vaadin.flow.component.applayout.DrawerToggle;
import com.vaadin.flow.component.html.H1;
import com.vaadin.flow.component.orderedlayout.FlexComponent;
import com.vaadin.flow.component.orderedlayout.HorizontalLayout;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.HighlightConditions;
import com.vaadin.flow.router.RouterLink;
import com.vaadin.flow.server.PWA;

public class MainLayout extends AppLayout { // (1)

    public MainLayout() {

    private void createHeader() {
        H1 logo = new H1("Vaadin CRM");
        logo.addClassNames("text-l", "m-m");

        HorizontalLayout header = new HorizontalLayout(
          new DrawerToggle(), // (2)

        header.setDefaultVerticalComponentAlignment(FlexComponent.Alignment.CENTER); // (3)
        header.addClassNames("py-0", "px-m");

        addToNavbar(header); // (4)


    private void createDrawer() {
        RouterLink listLink = new RouterLink("List", ListView.class); // (5)
        listLink.setHighlightCondition(HighlightConditions.sameLocation()); // (6)

        addToDrawer(new VerticalLayout( // (7)
  1. AppLayout is a Vaadin layout with a header and a responsive drawer.

  2. DrawerToggle is a menu button that toggles the visibility of the sidebar.

  3. Centers the components in the header along the vertical axis.

  4. Adds the header layout to the application layout’s nav bar, the section at the top of the screen.

  5. Creates a RouterLink with the text "List" and ListView.class as the destination view.

  6. Sets setHighlightCondition(HighlightConditions.sameLocation()) to avoid highlighting the link for partial route matches. (Technically, every route starts with an empty route, so without this, it would always show up as active, even though the user isn’t on the view.)

  7. Wraps the link in a VerticalLayout and adds it to the AppLayout drawer.

Add the following CSS to frontend/themes/flowcrmtutorial/styles.css to highlight the selected link.

a[highlight] {
    font-weight: bold;
    text-decoration: underline;

Lastly, in ListView, update the @Route mapping to use the new MainLayout.

@Route(value="", layout = MainLayout.class) // (1)
@PageTitle("Contacts | Vaadin CRM")
public class ListView extends VerticalLayout {
  1. ListView still matches the empty path, but now uses MainLayout as its parent.

Run the application. You should now see a header and a sidebar on the list view.

Application with sidebar list view

Creating a Dashboard View

Next, create a new dashboard view. This view shows stats: the number of contacts in the system and a pie chart of the number of contacts per company.

Dashboard view

Create a new Java class named DashboardView in the views package with the following content:

package com.example.application.views;

import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.charts.Chart;
import com.vaadin.flow.component.charts.model.ChartType;
import com.vaadin.flow.component.charts.model.DataSeries;
import com.vaadin.flow.component.charts.model.DataSeriesItem;
import com.vaadin.flow.component.html.Span;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.PageTitle;
import com.vaadin.flow.router.Route;

@Route(value = "dashboard", layout = MainLayout.class) // (1)
@PageTitle("Dashboard | Vaadin CRM")
public class DashboardView extends VerticalLayout {
    private final CrmService service;

    public DashboardView(CrmService service) { // (2)
        this.service = service;
        setDefaultHorizontalComponentAlignment(Alignment.CENTER); // (3)
        add(getContactStats(), getCompaniesChart());

    private Component getContactStats() {
        Span stats = new Span(service.countContacts() + " contacts"); // (4)
        stats.addClassNames("text-xl", "mt-m");
        return stats;

    private Chart getCompaniesChart() {
        Chart chart = new Chart(ChartType.PIE);

        DataSeries dataSeries = new DataSeries();
        service.findAllCompanies().forEach(company ->
            dataSeries.add(new DataSeriesItem(company.getName(), company.getEmployeeCount()))); // (5)
        return chart;
  1. DashboardView is mapped to the "dashboard" path and uses MainLayout as a parent layout.

  2. Takes CrmService as a constructor parameter and saves it as a field.

  3. Centers the contents of the layout.

  4. Calls the service to get the number of contacts.

  5. Calls the service to get all companies, then creates a DataSeriesItem for each, containing the company name and employee count.

Vaadin Charts is a Commercial Component Set

Vaadin Charts is a collection of data visualization components that’s a part of the Vaadin Pro subscription. Vaadin Charts comes with a free trial that you can activate in the browser. All Vaadin Pro tools and components are free for students through the GitHub Student Developer Pack.

Open and add the following field and getter to get the employee count without having to fetch all the entities.

@Formula("(select count( from Contact c where c.company_id = id)") // (1)
private int employeeCount;

public int getEmployeeCount(){
    return employeeCount;
  1. The Formula gets the count of employees without needing to fetch all the employees.

Add the Dashboard View to the Main Layout Sidebar

Add a navigation link to DashboardView in the MainLayout drawer:

private void createDrawer() {
    RouterLink listLink = new RouterLink("List", ListView.class);

    addToDrawer(new VerticalLayout(
        new RouterLink("Dashboard", DashboardView.class)

Build and run the application. You should now be able to navigate to the dashboard view and see stats on your CRM contacts. If you want to, go ahead and add or remove contacts in the list view to see that the dashboard reflects your changes.

Complete dashboard view

In the next chapter, you secure the application by adding a log-in screen.

migration assistance

Download free e-book.
The complete guide is also available in an easy-to-follow PDF format.

Open in a
new tab
export class RenderBanner extends HTMLElement {
  connectedCallback() {

  renderBanner() {
    let bannerWrapper = document.getElementById('tocBanner');

    if (bannerWrapper) {

    let tocEl = document.getElementById('toc');

    // Add an empty ToC div in case page doesn't have one.
    if (!tocEl) {
      const pageTitle = document.querySelector(
        'main > article > header[class^=PageHeader-module--pageHeader]'
      tocEl = document.createElement('div');

      pageTitle?.insertAdjacentElement('afterend', tocEl);

    // Prepare banner container
    bannerWrapper = document.createElement('div'); = 'tocBanner';

    // Banner elements
    const text = document.querySelector('.toc-banner-source-text')?.innerHTML;
    const link = document.querySelector('.toc-banner-source-link')?.textContent;

    const bannerHtml = `<div class='toc-banner'>
          <a href='${link}'>
            <div class="toc-banner--img"></div>
            <div class='toc-banner--content'>${text}</div>

    bannerWrapper.innerHTML = bannerHtml;

    // Add banner image
    const imgSource = document.querySelector('.toc-banner-source .image');
    const imgTarget = bannerWrapper.querySelector('.toc-banner--img');

    if (imgSource && imgTarget) {