Vaadin Dashboard

The Vaadin Dashboard add-on integrates the commercial Vaadin Dashboard component into Jmix. It arranges content into a responsive grid of widgets that users can move, resize, and remove at runtime.

The add-on provides the following features:

  • Declarative composition of the dashboard, its widgets, and its sections in the view XML descriptor.

  • A responsive grid that adapts the number of columns to the available width, with configurable column count, column width, row height, gap, and padding.

  • Widgets that hold any component tree, span several columns and rows, and have their own header content in addition to the title.

  • Collapsible sections that group related widgets.

  • An editable mode in which users move, resize, and remove widgets with the mouse or the keyboard, and events that report these changes to the view.

  • Localization of the edit mode controls through the standard Jmix message mechanism.

  • Design-time support in Jmix Studio, where the component is available in the Vaadin Commercial category of the view designer palette along with its property editors.

Typical use cases are analytical landing pages that combine charts, KPIs, and data grids. Another one is a personal workspace where users decide which widgets to keep and how to arrange them.

Installation

This add-on requires two subscriptions:

For automatic installation through Jmix Marketplace, follow instructions in the Add-ons section.

For manual installation, follow the steps below.

  1. Configure access to the premium repository.

    • Add the premium repository to your build.gradle:

      repositories {
    // ...
    maven {
        url = 'https://global.repo.jmix.io/repository/premium'
        credentials {
            username = rootProject['premiumRepoUser']
            password = rootProject['premiumRepoPass']
        }
    }
}

    • Add premium repository credentials to ~/.gradle/gradle.properties:

      premiumRepoUser=123456123456
premiumRepoPass=abcdefabcdef

      Get the repository credentials from your license key: the first part of the key before dash is the repository user name, the part after dash is the password. For example, if your key is 123456123456-abcdefabcdef, then the user name is 123456123456 and the password is abcdefabcdef.

  2. Add dependency to your build.gradle:

    implementation 'io.jmix.vcc:vaadin-dashboard-starter'

See Dashboard Component for the description of the component, its elements, attributes, and Java API.