vaadin-upload | Vaadin

The Web Component for uploading multiple files with progress indication. 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-upload> is a Web Component for uploading files, part of the Vaadin components.

<vaadin-upload accept=".pdf">
  <iron-icon slot="drop-label-icon" icon="description"></iron-icon>
  <span slot="drop-label">Drop your favourite Novels here (PDF files only)</span>

Screenshot of vaadin-upload


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-upload:

bower i vaadin/vaadin-upload --save

Once installed, import it in your application:

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

Polymer 3 and ES Modules Compatible Version

Install vaadin-upload:

npm i @vaadin/vaadin-upload --save

Once installed, import it in your application:

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


Running demos and tests in browser

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

  2. Make sure you have npm installed.

  3. When in the vaadin-upload 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-upload 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.

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 12 September 2018Apache License 2.0
Framework Support
Polymer 2.0+
Polymer 3.0+
Also supported:
Polymer 1 (2.0.0-alpha1)
Browser Compatibility
Install with
npm install @vaadin/vaadin-upload"@4.2.1"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 4.2.1


  • @polymer/polymer#^3.0.0
  • @vaadin/vaadin-themable-mixin#^1.2.1
  • @vaadin/vaadin-button#^2.1.0
  • @vaadin/vaadin-progress-bar#^1.1.0
  • @vaadin/vaadin-lumo-styles#^1.1.0
  • @vaadin/vaadin-material-styles#^1.1.0
  • @vaadin/vaadin-element-mixin#^2.0.0