<vaadin-accordion>

<vaadin-accordion> is a Web Component implementing the vertically stacked set of expandable panels, part of the Vaadin components.

Live Demo ↗ | API documentation ↗

⚠️ This is a pre-release version built with LitElement, part of the next generation of Vaadin web components.

Looking for Vaadin 14 compatible version? Please see the following branches:

• 1.0 branch (latest stable)
• 1.1 branch (next minor version with incremental improvements)

<vaadin-accordion>
  <vaadin-accordion-panel theme="filled">
    <div slot="summary">Accordion Panel 1</div>
    <div>Accordion is a set of expandable sections.</div>
  </vaadin-accordion-panel>
  <vaadin-accordion-panel theme="filled">
    <div slot="summary">Accordion Panel 2</div>
    <div>Only one accordion panel can be opened.</div>
  </vaadin-accordion-panel>
</vaadin-accordion>

Installation

Install vaadin-accordion:

npm i @vaadin/vaadin-accordion --save

Once installed, import it in your application:

import '@vaadin/vaadin-accordion/vaadin-accordion.js';

Getting started

Vaadin components use the Lumo theme by default.

To use the Material theme, import the correspondent file from the theme/material folder.

Entry points

• The component with the Lumo theme:

  theme/lumo/vaadin-accordion.js

• The component with the Material theme:

  theme/material/vaadin-accordion.js

• Alias for theme/lumo/vaadin-accordion.js:

  vaadin-accordion.js

Running demos and API docs in a browser

1. Fork the vaadin-accordion repository and clone it locally.

2. Make sure you have npm installed.

3. When in the vaadin-accordion directory, run npm install to install dependencies.

4. Run npm start, browser will automatically open the component API documentation.

Running tests from the command line

• When in the vaadin-accordion directory, run npm test

• To debug tests in the browser, run npm run test:debug

Following the coding style

We are using ESLint for linting TypeScript code. You can check if your code is following our standards by running npm run lint, which will automatically lint all .ts files.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2.0

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.