Package Exports

@vaadin/vaadin-accordion
@vaadin/vaadin-accordion/vaadin-accordion
@vaadin/vaadin-accordion/vaadin-accordion.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vaadin/vaadin-accordion) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

<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 ↗

<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 API docs and tests in a browser

Fork the vaadin-accordion repository and clone it locally.
Make sure you have node.js 12.x installed.
Make sure you have npm installed.
When in the vaadin-accordion directory, run npm install to install dependencies.
Run npm start, browser will automatically open the component API documentation.
You can also open visual tests, for example:

http://localhost:8000/test/visual/accordion.html

Running tests from the command line

When in the vaadin-accordion directory, run npm test

Debugging tests in the browser

Run npm run debug, then choose manual mode (M) and open the link in browser.

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running npm run lint, which will automatically lint all .js 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.