Package Exports
- @vaadin/vaadin-checkbox
- @vaadin/vaadin-checkbox/src/vaadin-checkbox
- @vaadin/vaadin-checkbox/src/vaadin-checkbox.js
- @vaadin/vaadin-checkbox/theme/lumo/vaadin-checkbox.js
- @vaadin/vaadin-checkbox/theme/material/vaadin-checkbox.js
- @vaadin/vaadin-checkbox/vaadin-checkbox-group
- @vaadin/vaadin-checkbox/vaadin-checkbox-group.js
- @vaadin/vaadin-checkbox/vaadin-checkbox.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vaadin/vaadin-checkbox) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
<vaadin-checkbox>
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>
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 browser
Fork the
vaadin-checkbox
repository and clone it locally.Make sure you have npm installed.
When in the
vaadin-checkbox
directory, runnpm install
and thenbower install
to install dependencies.Run
polymer serve --open
, 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:8080/components/vaadin-checkbox/demo
- http://127.0.0.1:8080/components/vaadin-checkbox/test
Running tests from the command line
- When in the
vaadin-checkbox
directory, runpolymer 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.
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.