org.webjars.bower:vaadin-checkbox

<vaadin-checkbox>

Live Demo ↗ | API documentation ↗

<vaadin-checkbox> is a Polymer 2 element providing an accessible and customizable checkbox, part of the Vaadin Core Elements.

<vaadin-checkbox checked>Checked</vaadin-checkbox>
<vaadin-checkbox>Unchecked</vaadin-checkbox>
<vaadin-checkbox indeterminate>Indeterminate</vaadin-checkbox>

Getting Started

Vaadin Elements use the Lumo theme by default.

The file structure for Vaadin Elements

• src/vaadin-checkbox.html

  Unstyled element.

• theme/lumo/vaadin-checkbox.html

  Element with Lumo theme.

• vaadin-checkbox.html

  Alias for theme/lumo/vaadin-checkbox.html

Running demos and tests in browser

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

2. Make sure you have npm installed.

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

• http://127.0.0.1:8080/components/vaadin-checkbox/demo
• http://127.0.0.1:8080/components/vaadin-checkbox/test

Running tests from the command line

1. When in the vaadin-checkbox 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 Elements 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.