Documentation versions (currently viewingVaadin 8)

Vaadin 8 reached End of Life on February 21, 2022. Discover how to make your Vaadin 8 app futureproof →

Getting Started

Vaadin Designer works projects using Vaadin Framework 8. In short, create a new project as described in "Creating a Vaadin Project".

Creating a Design

With your project selected, create a new design:

  • In Eclipse select File  New  Other, choose Vaadin 8 Design from the list, and click Next.

  • In IntelliJ IDEA select File  New, choose Vaadin 8 Design from the list

designer new design
Creating a New Vaadin Design

In the design parameters step, make sure the locations are correct. You can put the design in a specific package if you wish.

designer new parameters
New Design Parameters

Give your design a descriptive name. Using a naming convention to separate the design’s companion Java file from the classes using it will make things easier for you later.

For example, the name UserEditorDesign will result in UserEditorDesign.html and You could then create a UserEditor component that extends the UserEditorDesign, and perhaps a UserEditorView to place the editor component in a bigger context.

In another case, you could make a LoginDesign that is used in a LoginWindow (but not extended).

Finally, you can choose a template as starting point, or start from scratch (Blank).

Choose Finish to create the design and open Vaadin Designer.

Vaadin Designer GUI Overview

Vaadin Designer is fully integrated with the IDE and its views can therefore be freely moved and arranged as you wish. However, it is best to first try the Designer in its default setup. In Eclipse, this can be done by choosing Show perspective from the dialog that is presented when a new design is created.

To be able to successfully use the Designer, you will need the Outline, Palette and Properties views, in addition to the main editor.

designer view annotated lo
Panels in Vaadin Perspective

The elements of the perspective illustrated in Panels in Vaadin Perspective are as follows:

  1. Design files

  2. Editor (see below for close-up)

  3. Component palette

  4. Outline - component hierarchy

  5. Properties for the selected component

In the editor view, illustrated in Component Editor, you have a number of controls in the toolbar.

designer editor annotated lo
Component Editor
  1. Center viewport

  2. Viewport size and presets

  3. Rotate viewport (portrait / landscape)

  4. Configure canvas; rulers, grids, snapping, public getters

  5. Theme selector

  6. Design / Code / Quick preview -modes

  7. External preview