Skip to content

Latest commit

 

History

History
48 lines (26 loc) · 2.3 KB

README.md

File metadata and controls

48 lines (26 loc) · 2.3 KB

Material Theme for Vaadin components

⚠️ Starting from Vaadin 20, the source code and issues for this package are migrated to the vaadin/web-components monorepository. This repository contains the source code and releases of @vaadin/vaadin-material-styles for the Vaadin versions 10 to 19.

vaadin-material-styles is customizable theme for the Vaadin components.

npm version Bower version Gitter

Running demos and tests in browser

  1. Fork the vaadin-material-styles repository and clone it locally.

  2. Make sure you have npm installed.

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

Creating a pull request

  • 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