Accordion

Anatomy
Theme Variants
Disabled Panels
Best Practices
Related Components

Accordion is a vertically stacked set of expandable panels. It reduces clutter and helps maintain the user’s focus by showing only the relevant content at a time.

Open in a
new tab

Source code

AccordionBasic.javapackage com.vaadin.demo.component.accordion;

import com.vaadin.flow.component.accordion.Accordion;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.html.Span;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.Route;

@Route("accordion-basic")
public class AccordionBasic extends Div {

  public AccordionBasic() {
    // tag::snippet[]
    Accordion accordion = new Accordion();

    Span name = new Span("Sophia Williams");
    Span email = new Span("sophia.williams@company.com");
    Span phone = new Span("(501) 555-9128");
    
    VerticalLayout personalInformationLayout = new VerticalLayout(name, email, phone);
    personalInformationLayout.setSpacing(false);
    personalInformationLayout.setPadding(false);

    accordion.add("Personal information", personalInformationLayout);
    // end::snippet[]

    Span street = new Span("4027 Amber Lake Canyon");
    Span zipCode = new Span("72333-5884 Cozy Nook");
    Span city = new Span("Arkansas");

    VerticalLayout billingAddressLayout = new VerticalLayout();
    billingAddressLayout.setSpacing(false);
    billingAddressLayout.setPadding(false);
    billingAddressLayout.add(street, zipCode, city);
    accordion.add("Billing address", billingAddressLayout);

    Span cardBrand = new Span("Mastercard");
    Span cardNumber = new Span("1234 5678 9012 3456");
    Span expiryDate = new Span("Expires 06/21");

    VerticalLayout paymentLayout = new VerticalLayout();
    paymentLayout.setSpacing(false);
    paymentLayout.setPadding(false);
    paymentLayout.add(cardBrand, cardNumber, expiryDate);
    accordion.add("Payment", paymentLayout);

    add(accordion);
  }

}

Anatomy

Accordion consists of stacked panels, each composed of two parts: a summary and a content area. Only one panel can be expanded at a time. (The Details component can be used to allow multiple simultaneously expanded sections.)

Summary

The summary is the part that is always visible, and typically describes the contents, for example, with a title. Clicking on the summary toggles the content area’s visibility.

The summary supports rich content and can contain any component. This can be utilized, for example, to display the status of the corresponding content.

Open in a
new tab

Source code

AccordionSummary.javapackage com.vaadin.demo.component.accordion;

import com.vaadin.demo.domain.*;
import com.vaadin.flow.component.accordion.Accordion;
import com.vaadin.flow.component.accordion.AccordionPanel;
import com.vaadin.flow.component.button.Button;
import com.vaadin.flow.component.button.ButtonVariant;
import com.vaadin.flow.component.combobox.ComboBox;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.html.Span;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;

@Route("accordion-summary")
public class AccordionSummary extends Div {

    private static final String PAYMENT = "Payment";
    private static final String BILLING_ADDRESS = "Billing address";
    private static final String CUSTOMER_DETAILS = "Customer details";

    public AccordionSummary() {
        Accordion accordion = new Accordion();

        Binder<Person> personBinder = new Binder<>(Person.class);
        personBinder.setBean(new Person());

        Binder<Card> cardBinder = new Binder<>(Card.class);
        cardBinder.setBean(new Card());

        FormLayout customerDetailsFormLayout = createFormLayout();
        // tag::snippet[]
        AccordionPanel customDetailsPanel = accordion.add(CUSTOMER_DETAILS,  customerDetailsFormLayout);
        // end::snippet[]

        FormLayout billingAddressFormLayout = createFormLayout();
        AccordionPanel billingAddressPanel = accordion.add(BILLING_ADDRESS,  billingAddressFormLayout);
        
        FormLayout paymentFormLayout = createFormLayout();
        AccordionPanel paymentPanel = accordion.add(PAYMENT,  paymentFormLayout);

        // Customer details fields

        TextField firstName = new TextField("First name");
        personBinder.forField(firstName).bind("firstName");

        TextField lastName = new TextField("Last name");
        personBinder.forField(lastName).bind("lastName");

        EmailField email = new EmailField("Email address");
        personBinder.forField(email).bind("email");

        TextField phone = new TextField("Phone number");
        personBinder.forField(phone).bind(person -> {
            if  (person.getAddress() != null) {
                return person.getAddress().getPhone();
            }
            return "";
        }, (person, value) -> {
            if (person.getAddress() == null) {
                person.setAddress(new Address());
            }
            person.getAddress().setPhone(value);
        });

        customerDetailsFormLayout.add(firstName, lastName);
        customerDetailsFormLayout.add(email, 2);
        customerDetailsFormLayout.add(phone, 2);

        // tag::snippet[]
        customDetailsPanel.addOpenedChangeListener(e -> {
            if(e.isOpened()) {
                customDetailsPanel.setSummaryText(CUSTOMER_DETAILS);
            } else if(personBinder.getBean() != null) {
                Person personValues = personBinder.getBean();
                customDetailsPanel.setSummary(createSummary(CUSTOMER_DETAILS,
                    personValues.getFirstName() + " " + personValues.getLastName(),
                    personValues.getEmail(),
                    personValues.getAddress() != null ? personValues.getAddress().getPhone() : ""
                ));
            }
        });
        // end::snippet[]

        Button customDetailsButton = new Button("Continue", (e) -> billingAddressPanel.setOpened(true));
        customDetailsButton.addThemeVariants(ButtonVariant.LUMO_PRIMARY);
        customDetailsPanel.addContent(customDetailsButton);

        // Billing address fields
        
        TextField address = new TextField("Address");
        personBinder.forField(address).bind(person -> {
            if  (person.getAddress() != null) {
                return person.getAddress().getStreet();
            }
            return "";
        }, (person, value) -> {
            if (person.getAddress() == null) {
                person.setAddress(new Address());
            }
            person.getAddress().setStreet(value);
        });

        TextField zipCode = new TextField("ZIP code");
        personBinder.forField(zipCode).bind(person -> {
            if  (person.getAddress() != null) {
                return person.getAddress().getZip();
            }
            return "";
        }, (person, value) -> {
            if (person.getAddress() == null) {
                person.setAddress(new Address());
            }
            person.getAddress().setZip(value);
        });
        
        TextField city = new TextField("City");
        personBinder.forField(city).bind(person -> {
            if  (person.getAddress() != null) {
                return person.getAddress().getCity();
            }
            return "";
        }, (person, value) -> {
            if (person.getAddress() == null) {
                person.setAddress(new Address());
            }
            person.getAddress().setCity(value);
        });
        
        ComboBox<Country> countries = new ComboBox<>("Country");
        countries.setItems(DataService.getCountries());
        countries.setItemLabelGenerator(Country::getName);
        personBinder.forField(countries).bind(person -> {
            if  (person.getAddress() != null) {
                Country country = new Country();
                country.setName(person.getAddress().getCountry());
                return country;
            }
            return null;
        }, (person, value) -> {
            if (person.getAddress() == null) {
                person.setAddress(new Address());
            }
            person.getAddress().setCountry(value.getName());
        });

        billingAddressFormLayout.add(address, 2);
        billingAddressFormLayout.add(zipCode, city, countries);

        billingAddressPanel.addOpenedChangeListener(e -> {
            if(e.isOpened()) {
                billingAddressPanel.setSummaryText(BILLING_ADDRESS);
            } else if(personBinder.getBean().getAddress() != null) {
                Address addressValues = personBinder.getBean().getAddress();
                billingAddressPanel.setSummary(createSummary(BILLING_ADDRESS,
                    addressValues.getStreet(),
                    addressValues.getZip() + " " + addressValues.getCity(),
                    addressValues.getCountry()
                ));
            }
        });

        Button billingAddressButton = new Button("Continue", (e) -> paymentPanel.setOpened(true));
        billingAddressButton.addThemeVariants(ButtonVariant.LUMO_PRIMARY);
        billingAddressPanel.addContent(billingAddressButton);

        // Payment fields
        TextField accountNumber = new TextField("Card number");
        cardBinder.forField(accountNumber).bind("accountNumber");

        TextField expiryDate = new TextField("Expiry date");
        cardBinder.forField(expiryDate).bind("expiryDate");

        TextField cvv = new TextField("CVV");
        cardBinder.forField(cvv).bind("cvv");

        paymentFormLayout.add(accountNumber, 2);
        paymentFormLayout.add(expiryDate, cvv);

        paymentPanel.addOpenedChangeListener(e -> {
            if(e.isOpened()) {
                paymentPanel.setSummaryText(PAYMENT);
            } else if(cardBinder.getBean() != null) {
                Card cardValues = cardBinder.getBean();
                paymentPanel.setSummary(createSummary(PAYMENT,
                    cardValues.getAccountNumber(),
                    cardValues.getExpiryDate()
                ));
            }
        });

        Button paymentButton = new Button("Finish", (e) -> paymentPanel.setOpened(false));
        paymentButton.addThemeVariants(ButtonVariant.LUMO_PRIMARY);
        paymentPanel.addContent(paymentButton);


        add(accordion);
    }

    private FormLayout createFormLayout() {
        FormLayout billingAddressFormLayout = new FormLayout();
        billingAddressFormLayout.setResponsiveSteps(
          new FormLayout.ResponsiveStep("0", 1),
          new FormLayout.ResponsiveStep("20em", 2)
        );
        return billingAddressFormLayout;
    }

    private VerticalLayout createSummary(String title, String... details) {
        VerticalLayout layout = new VerticalLayout();
        layout.setSpacing(false);
        layout.setPadding(false);

        layout.add(title);

        if (details.length > 0) {   
            VerticalLayout detailsLayout = new VerticalLayout();
            detailsLayout.setSpacing(false);
            detailsLayout.setPadding(false);
            detailsLayout.getStyle().set("font-size", "var(--lumo-font-size-s)");
            
            for (String detail: details) {
                if (detail != null && !detail.isEmpty()) {
                    detailsLayout.add(new Span(detail));
                }
            }
            
            layout.add(detailsLayout);
        }

        return layout;
    }

}

Content

This is the collapsible part of a panel. It can contain any component. When the content area is collapsed, the content is invisible and inaccessible by keyboard or screen reader.

Open in a
new tab

Source code

AccordionContent.javapackage com.vaadin.demo.component.accordion;

import com.vaadin.flow.component.accordion.Accordion;
import com.vaadin.flow.component.accordion.AccordionPanel;
import com.vaadin.flow.component.html.Anchor;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.dom.ElementConstants;
import com.vaadin.flow.router.Route;

@Route("accordion-content")
public class AccordionContent extends Div {

    public AccordionContent() {
        // tag::snippet[]
        Accordion accordion = new Accordion();

        accordion.add("Analytics", createContent(
            createStyledAnchor("#", "Dashboard"),
            createStyledAnchor("#", "Reports"),
            createStyledAnchor("#", "Data sources")
        ));
        // end::snippet[]

        accordion.add("Customers", createContent(
            createStyledAnchor("#", "Accounts"),
            createStyledAnchor("#", "Contacts")
        ));

        AccordionPanel financesPanel = new AccordionPanel();
        financesPanel.setSummaryText("Finances");
        financesPanel.addContent(createContent(
            createStyledAnchor("#", "Invoices"),
            createStyledAnchor("#", "Transactions"),
            createStyledAnchor("#", "Statements")
        ));
        accordion.add(financesPanel);

        add(accordion);
    }
    
    private VerticalLayout createContent(Anchor ...anchors) {
        VerticalLayout content = new VerticalLayout();
        content.setPadding(false);
        content.setSpacing(false);
        content.add(anchors);

        return content;
    }
    
    private Anchor createStyledAnchor(String href, String text) {
        Anchor anchor = new Anchor(href, text);
        anchor.getStyle().set(ElementConstants.STYLE_COLOR, "var(--lumo-primary-text-color)");
        anchor.getStyle().set("text-decoration", "none");

        return anchor;
    } 

}

Theme Variants

Accordion has three theme variants: filled, small and reverse. Set the theme attribute separately for each panel, not on Accordion itself. Theme names can be combined with each other, for example, all three themes filled, small, and reverse can be applied to a panel.

Filled Panels

The filled theme variant makes the panel’s boundaries visible, which helps tie its content together visually and distinguishes it from the surrounding UI.

Open in a
new tab

Source code

AccordionFilledPanels.javapackage com.vaadin.demo.component.accordion;

import com.vaadin.flow.component.accordion.Accordion;
import com.vaadin.flow.component.accordion.AccordionPanel;
import com.vaadin.flow.component.details.DetailsVariant;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.html.Span;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.Route;

@Route("accordion-filled-panels")
public class AccordionFilledPanels extends Div {

    public AccordionFilledPanels() {
        // tag::snippet[]
        Accordion accordion = new Accordion();
        // end::snippet[]

        Span name = new Span("Sophia Williams");
        Span email = new Span("sophia.williams@company.com");
        Span phone = new Span("(501) 555-9128");

        VerticalLayout personalInformationLayout = new VerticalLayout(name, email, phone);
        personalInformationLayout.setSpacing(false);
        personalInformationLayout.setPadding(false);

        // tag::snippet[]
        AccordionPanel personalInfoPanel = accordion.add("Personal information", personalInformationLayout);
        personalInfoPanel.addThemeVariants(DetailsVariant.FILLED);
        // end::snippet[]

        Span street = new Span("4027 Amber Lake Canyon");
        Span zipCode = new Span("72333-5884 Cozy Nook");
        Span city = new Span("Arkansas");

        VerticalLayout billingAddressLayout = new VerticalLayout();
        billingAddressLayout.setSpacing(false);
        billingAddressLayout.setPadding(false);
        billingAddressLayout.add(street, zipCode, city);
        
        AccordionPanel billingAddressPanel = accordion.add("Billing address", billingAddressLayout);
        billingAddressPanel.addThemeVariants(DetailsVariant.FILLED);

        Span cardBrand = new Span("Mastercard");
        Span cardNumber = new Span("1234 5678 9012 3456");
        Span expiryDate = new Span("Expires 06/21");

        VerticalLayout paymentLayout = new VerticalLayout();
        paymentLayout.setSpacing(false);
        paymentLayout.setPadding(false);
        paymentLayout.add(cardBrand, cardNumber, expiryDate);
        
        AccordionPanel paymentPanel = accordion.add("Payment", paymentLayout);
        paymentPanel.addThemeVariants(DetailsVariant.FILLED);

        add(accordion);
    }

}

Small Panels

Use the small theme variant for compact UIs.

Open in a
new tab

Source code

AccordionSmallPanels.javapackage com.vaadin.demo.component.accordion;

import com.vaadin.flow.component.accordion.Accordion;
import com.vaadin.flow.component.accordion.AccordionPanel;
import com.vaadin.flow.component.details.DetailsVariant;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.html.Span;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.Route;

@Route("accordion-small-panels")
public class AccordionSmallPanels extends Div {

    public AccordionSmallPanels() {
        Accordion accordion = new Accordion();

        Span name = new Span("Sophia Williams");
        Span email = new Span("sophia.williams@company.com");
        Span phone = new Span("(501) 555-9128");

        VerticalLayout personalInformationLayout = new VerticalLayout(name, email, phone);
        personalInformationLayout.setSpacing(false);
        personalInformationLayout.setPadding(false);

        AccordionPanel personalInfoPanel = accordion.add("Personal information", personalInformationLayout);
        personalInfoPanel.addThemeVariants(DetailsVariant.SMALL);

        Span street = new Span("4027 Amber Lake Canyon");
        Span zipCode = new Span("72333-5884 Cozy Nook");
        Span city = new Span("Arkansas");

        VerticalLayout billingAddressLayout = new VerticalLayout();
        billingAddressLayout.setSpacing(false);
        billingAddressLayout.setPadding(false);
        billingAddressLayout.add(street, zipCode, city);
        
        AccordionPanel billingAdressPanel = accordion.add("Billing address", billingAddressLayout);
        billingAdressPanel.addThemeVariants(DetailsVariant.SMALL);

        Span cardBrand = new Span("Mastercard");
        Span cardNumber = new Span("1234 5678 9012 3456");
        Span expiryDate = new Span("Expires 06/21");

        VerticalLayout paymentLayout = new VerticalLayout();
        paymentLayout.setSpacing(false);
        paymentLayout.setPadding(false);
        paymentLayout.add(cardBrand, cardNumber, expiryDate);
        
        // tag::snippet[]
        AccordionPanel paymentPanel = accordion.add("Payment", paymentLayout);
        paymentPanel.addThemeVariants(DetailsVariant.SMALL);
        // end::snippet[]

        add(accordion);
    }

}

Reverse Panels

The reverse theme variant places the toggle icon after the summary contents, which can be useful for visually aligning the summary with other content.

Open in a
new tab

Source code

AccordionReversePanels.javapackage com.vaadin.demo.component.accordion;

import com.vaadin.flow.component.accordion.Accordion;
import com.vaadin.flow.component.accordion.AccordionPanel;
import com.vaadin.flow.component.details.DetailsVariant;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.html.Span;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.Route;

@Route("accordion-reverse-panels")
public class AccordionReversePanels extends Div {

    public AccordionReversePanels() {
        Accordion accordion = new Accordion();

        Span name = new Span("Sophia Williams");
        Span email = new Span("sophia.williams@company.com");
        Span phone = new Span("(501) 555-9128");

        VerticalLayout personalInformationLayout = new VerticalLayout(name, email, phone);
        personalInformationLayout.setSpacing(false);
        personalInformationLayout.setPadding(false);

        AccordionPanel personalInfoPanel = accordion.add("Personal information", personalInformationLayout);
        personalInfoPanel.addThemeVariants(DetailsVariant.REVERSE);

        Span street = new Span("4027 Amber Lake Canyon");
        Span zipCode = new Span("72333-5884 Cozy Nook");
        Span city = new Span("Arkansas");

        VerticalLayout billingAddressLayout = new VerticalLayout();
        billingAddressLayout.setSpacing(false);
        billingAddressLayout.setPadding(false);
        billingAddressLayout.add(street, zipCode, city);
        
        AccordionPanel billingAddressPanel = accordion.add("Billing address", billingAddressLayout);
        billingAddressPanel.addThemeVariants(DetailsVariant.REVERSE);

        Span cardBrand = new Span("Mastercard");
        Span cardNumber = new Span("1234 5678 9012 3456");
        Span expiryDate = new Span("Expires 06/21");

        VerticalLayout paymentLayout = new VerticalLayout();
        paymentLayout.setSpacing(false);
        paymentLayout.setPadding(false);
        paymentLayout.add(cardBrand, cardNumber, expiryDate);
        
        // tag::snippet[]
        AccordionPanel paymentPanel = accordion.add("Payment", paymentLayout);
        paymentPanel.addThemeVariants(DetailsVariant.REVERSE);
        // end::snippet[]

        add(accordion);
    }

}

Disabled Panels

Accordion panels can be disabled to prevent them from being expanded or collapsed. Details can be disabled to prevent them from being expanded or collapsed. Components inside a disabled expanded panel are automatically disabled as well.

Open in a
new tab

Source code

AccordionDisabledPanels.javapackage com.vaadin.demo.component.accordion;

import com.vaadin.flow.component.accordion.Accordion;
import com.vaadin.flow.component.accordion.AccordionPanel;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.html.Span;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.Route;

@Route("accordion-disabled-panels")
public class AccordionDisabledPanels extends Div {

    public AccordionDisabledPanels() {
        // tag::snippet[]
        Accordion accordion = new Accordion();
        // end::snippet[]

        Span name = new Span("Sophia Williams");
        Span email = new Span("sophia.williams@company.com");
        Span phone = new Span("(501) 555-9128");

        VerticalLayout personalInformationLayout = new VerticalLayout(name, email, phone);
        personalInformationLayout.setSpacing(false);
        personalInformationLayout.setPadding(false);

        accordion.add("Personal information", personalInformationLayout);

        Span street = new Span("4027 Amber Lake Canyon");
        Span zipCode = new Span("72333-5884 Cozy Nook");
        Span city = new Span("Arkansas");

        VerticalLayout billingAddressLayout = new VerticalLayout();
        billingAddressLayout.setSpacing(false);
        billingAddressLayout.setPadding(false);
        billingAddressLayout.add(street, zipCode, city);
        
        // tag::snippet[]
        AccordionPanel billingAdressPanel = accordion.add("Billing address", billingAddressLayout);
        billingAdressPanel.setEnabled(false);
        // end::snippet[]

        Span cardBrand = new Span("Mastercard");
        Span cardNumber = new Span("1234 5678 9012 3456");
        Span expiryDate = new Span("Expires 06/21");

        VerticalLayout paymentLayout = new VerticalLayout();
        paymentLayout.setSpacing(false);
        paymentLayout.setPadding(false);
        paymentLayout.add(cardBrand, cardNumber, expiryDate);
        
        AccordionPanel paymentPanel = accordion.add("Payment", paymentLayout);
        paymentPanel.setEnabled(false);

        add(accordion);
    }

}

Best Practices

Accordions are suitable when users need to focus on smaller pieces of content at a time. However, when the whole content is relevant to the user to make a decision, Accordions should be avoided.
Contents that are logically linked should be grouped together in one panel.
Accordions are better suited for long labels compared to Tabs. However, Accordions can feel “jumpy” as panels are toggled (if there are a lot of panels or the panel content is long).
Details can be used instead of Accordion when there is a need to see content from multiple panels simultaneously.
Accordions can be used to break a complex form into smaller step-by-step sections.

Component	Usage recommendations
Details	Single collapsible panel.
Tabs	Component for organizing and grouping content into navigable sections.

Component

Usage recommendations

Details

Single collapsible panel.

Tabs

Component for organizing and grouping content into navigable sections.

A9679DB2-C376-4307-B391-0AEFF5F611FD

Docs

Docs

Accordion

Anatomy

Summary

Content

Theme Variants

Filled Panels

Small Panels

Reverse Panels

Disabled Panels

Best Practices

Docs

Anatomy

Summary

Content

Theme Variants

Filled Panels

Small Panels

Reverse Panels

Disabled Panels

Best Practices

Related Components