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

npm version Bower version Published on Build Status Coverage Status Gitter

Published on Vaadin  Directory Stars on


Live Demo ↗ | API documentation ↗

<vaadin-button> is a Web Component providing an accessible and customizable button, part of the Vaadin components.

<vaadin-button theme="primary">Primary</vaadin-button>
<vaadin-button theme="secondary">Secondary</vaadin-button>
<vaadin-button theme="tertiary">Tertiary</vaadin-button>

Screenshot of vaadin-button, using the default Lumo theme


The Vaadin components are distributed as Bower and npm packages. Please note that the version range is the same, as the API has not changed. You should not mix Bower and npm versions in the same application, though.

Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components are only published on npm, not pushed to GitHub repositories.

Polymer 2 and HTML Imports compatible version

Install vaadin-button:

bower i vaadin/vaadin-button --save

Once installed, import it in your application:

<link rel="import" href="bower_components/vaadin-button/vaadin-button.html">

Polymer 3 and ES Modules compatible version

Install vaadin-button:

npm i @vaadin/vaadin-button --save

Once installed, import it in your application:

import '@vaadin/vaadin-button/vaadin-button.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:


  • The component with the Material theme:


  • Alias for theme/lumo/vaadin-button.html:


Running demos and tests in a browser

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

  2. Make sure you have npm and Bower installed.

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

  4. Run npm start, 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-button 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 npm run lint, which will automatically lint all .js files as well as JavaScript snippets inside .html files.

Big Thanks

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


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


Apache License 2.0

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see


Link to this version
ImportedReleased 23 April 2019Apache License 2.0
Framework Support
Polymer 2.0+
Polymer 3.0+
Browser Independent
Install with
npm install @vaadin/vaadin-button"@2.2.0"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.2.0


  • @polymer/polymer#^3.0.0
  • @vaadin/vaadin-control-state-mixin#^2.1.1
  • @vaadin/vaadin-themable-mixin#^1.2.1
  • @vaadin/vaadin-lumo-styles#^1.3.3
  • @vaadin/vaadin-material-styles#^1.2.0
  • @vaadin/vaadin-element-mixin#^2.0.0