Documentation versions (currently viewingVaadin 14)

You are viewing documentation for an older Vaadin version. View latest documentation

Creating a Component with Multiple Elements

In this section we demonstrate how to create a component using the Element API and multiple DOM elements. We create a TextField component that supports a label.

Example: DOM structure of the component.


Example: TextField component with <input> and <label> elements

public class TextField extends Component {

    Element labelElement = new Element("label");
    Element inputElement = new Element("input");

    public TextField() {
               .synchronizeProperty("value", "change");
               .appendChild(labelElement, inputElement);
  • The DOM structure is set up by marking the root element as a <div> in the @Tag annotation.

  • The label and input elements are appended to the root element.

  • Value synchronization is set up using the input element.

See Creating a Simple Component Using the Element API for an alternative way to synchronize.

Adding an API

To make the component easier to use, you can add an API to set the input value and label text.

Example: Adding an API to get and set values for the input and label elements.

  public String getLabel() {
      return labelElement.getText();

  public String getValue() {
      return inputElement.getProperty("value");

  public void setLabel(String label) {

  public void setValue(String value) {
    inputElement.setProperty("value", value);