/vaadin-tabs

The Web Component for customized tabs. Part of the Vaadin components.

Primary LanguageHTMLApache License 2.0Apache-2.0

npm version Published on webcomponents.org Build Status Gitter

Published on Vaadin Directory Stars on vaadin.com/directory

<vaadin-tabs>

Live Demo ↗ | API documentation ↗

<vaadin-tabs> is a Polymer 2 element providing item navigation part of the Vaadin components. It is designed for menu and tab components.

<vaadin-tabs selected="3">
  <vaadin-tab>Page 1</vaadin-tab>
  <vaadin-tab>Page 2</vaadin-tab>
  <vaadin-tab>Page 3</vaadin-tab>
  <vaadin-tab>Page 4</vaadin-tab>
</vaadin-tabs>

Screenshot of vaadin-tabs, using the default Lumo theme

Getting Started

Vaadin components use the Lumo theme by default.

The file structure for Vaadin components

  • src/vaadin-tab.html

  • src/vaadin-tabs.html

    Unstyled components.

  • theme/lumo/vaadin-tab.html

  • theme/lumo/vaadin-tabs.html

    Components with Lumo theme.

  • vaadin-tab.html

  • vaadin-tabs.html

    Alias for theme/lumo/vaadin-tab.html theme/lumo/vaadin-tabs.html

Running demos and tests in browser

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

  2. Make sure you have npm installed.

  3. When in the vaadin-tabs directory, run npm install and then bower install to install dependencies.

  4. Run polymer serve --open, browser will automatically open the component API documentation.

  5. You can also open demo or in-browser tests by adding demo or test to the URL, for example:

Running tests from the command line

  1. When in the vaadin-tabs directory, run polymer test

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint, which will automatically lint all .js files as well as JavaScript snippets inside .html files.

Contributing

  • Make sure your code is compliant with our code linters: gulp lint
  • Check that tests are passing: polymer test
  • Submit a pull request with detailed title and description
  • Wait for response from one of Vaadin components team members

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.