Live Demo ↗ | API documentation ↗
<vaadin-checkbox> is a Web Component providing an accessible and customizable checkbox, part of the Vaadin components.
<vaadin-checkbox checked>Checked</vaadin-checkbox>
<vaadin-checkbox>Unchecked</vaadin-checkbox>
<vaadin-checkbox indeterminate>Indeterminate</vaadin-checkbox>
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.
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">
Install vaadin-checkbox
:
npm i @vaadin/vaadin-checkbox --save
Once installed, import it in your application:
import '@vaadin/vaadin-checkbox/vaadin-checkbox.js';
Vaadin components use the Lumo theme by default.
To use the Material theme, import the correspondent file from the theme/material
folder.
-
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
-
Fork the
vaadin-checkbox
repository and clone it locally. -
When in the
vaadin-checkbox
directory, runnpm install
and thenbower install
to install dependencies. -
Run
npm start
, browser will automatically open the component API documentation. -
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
- When in the
vaadin-checkbox
directory, runpolymer test
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.
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 https://github.com/vaadin/vaadin-usage-statistics.