https://github.com/vaadin/vaadin-material-styles

Material Design Theme for Vaadin components
https://github.com/vaadin/vaadin-material-styles

material-design polymer theme vaadin web-components webcomponents

Last synced: 4 months ago
JSON representation

Material Design Theme for Vaadin components

• Host: GitHub
• URL: https://github.com/vaadin/vaadin-material-styles
• Owner: vaadin
• License: apache-2.0
• Created: 2017-09-05T07:24:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-07-15T11:46:45.000Z (over 3 years ago)
• Last Synced: 2024-10-11T12:41:11.019Z (4 months ago)
• Topics: material-design, polymer, theme, vaadin, web-components, webcomponents
• Language: HTML
• Homepage: https://vaadin.com/themes
• Size: 2.19 MB
• Stars: 13
• Watchers: 14
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Material Theme for Vaadin components

> ⚠️ Starting from Vaadin 20, the source code and issues for this package are migrated to the [`vaadin/web-components`](https://github.com/vaadin/web-components/tree/master/packages/vaadin-material-styles) 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](https://vaadin.com/components).

[![npm version](https://badgen.net/npm/v/@vaadin/vaadin-material-styles)](https://www.npmjs.com/package/@vaadin/vaadin-material-styles)

[![Bower version](https://badgen.net/github/release/vaadin/vaadin-material-styles)](https://github.com/vaadin/vaadin-material-styles/releases)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

## Running demos and tests in browser

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

1. Make sure you have [npm](https://www.npmjs.com/) installed.

1. When in the `vaadin-material-styles` directory, run `npm install` and then `bower install` to install dependencies.

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

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

  - http://127.0.0.1:8080/components/vaadin-material-styles/demo

  - http://127.0.0.1:8080/components/vaadin-material-styles/test

## 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](http://eslint.org/) 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](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description

  - Wait for response from one of Vaadin components team members

## License

Apache License 2.0