@vaadin/vaadin-checkbox

<vaadin-checkbox>

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

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

Live Demo ↗ | API documentation ↗

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

Installation

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

bower i vaadin/vaadin-checkbox --save

Once installed, import it in your application:

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

Polymer 3 and ES Modules Compatible Version

Install vaadin-checkbox:

npm i @vaadin/vaadin-checkbox --save

Once installed, import it in your application:

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

The file structure for Vaadin components

• The component with the Lumo theme:

  theme/lumo/vaadin-checkbox.html

• The component with the Material theme:

  theme/material/vaadin-checkbox.html

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

  vaadin-checkbox.html

Running demos and tests in a browser

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

2. Make sure you have npm and Bower installed.

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

• http://127.0.0.1:3000/components/vaadin-checkbox/demo
• http://127.0.0.1:3000/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 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.

Contributing

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

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.