Contact us Create app

Directory

← Back

vaadin-checkbox

The Web Component for customized checkboxes. Part of the Vaadin components.

Author

Rating

Links

Popularity

<100

npm version Bower version Published on webcomponents.org Build Status Coverage Status Gitter

Published on Vaadin Directory Stars on vaadin.com/directory

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

Screenshot of vaadin-checkbox, using the default Lumo theme

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:

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.

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.

Compatibility

(Loading compatibility data...)

Last updated: 2018-11-01

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

  • polymer#^2.0.0
  • vaadin-control-state-mixin#vaadin/vaadin-control-state-mixin#^2.1.1
  • vaadin-themable-mixin#vaadin/vaadin-themable-mixin#^1.2.1
  • vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.2.0
  • vaadin-material-styles#vaadin/vaadin-material-styles#^1.2.0
  • vaadin-element-mixin#vaadin/vaadin-element-mixin#^2.0.0
Released
2019-05-15
Maturity
IMPORTED
License
Apache License 2.0

Compatibility

Framework
Polymer 2.0+
Polymer 3.0+ in 2.2.7
Browser
Browser Independent

vaadin-checkbox - Vaadin Add-on Directory

The Web Component for customized checkboxes. Part of the Vaadin components. vaadin-checkbox - Vaadin Add-on Directory
[![npm version](https://badgen.net/npm/v/@vaadin/vaadin-checkbox)](https://www.npmjs.com/package/@vaadin/vaadin-checkbox) [![Bower version](https://badgen.net/github/release/vaadin/vaadin-checkbox)](https://github.com/vaadin/vaadin-checkbox/releases) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vaadin/vaadin-checkbox) [![Build Status](https://travis-ci.org/vaadin/vaadin-checkbox.svg?branch=master)](https://travis-ci.org/vaadin/vaadin-checkbox) [![Coverage Status](https://coveralls.io/repos/github/vaadin/vaadin-checkbox/badge.svg?branch=master)](https://coveralls.io/github/vaadin/vaadin-checkbox?branch=master) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadinvaadin-checkbox) [![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/vaadinvaadin-checkbox.svg)](https://vaadin.com/directory/component/vaadinvaadin-checkbox) # <vaadin-checkbox> [Live Demo ↗](https://vaadin.com/components/vaadin-checkbox/html-examples) | [API documentation ↗](https://vaadin.com/components/vaadin-checkbox/html-api) [<vaadin-checkbox>](https://vaadin.com/components/vaadin-checkbox) is a Web Component providing an accessible and customizable checkbox, part of the [Vaadin components](https://vaadin.com/components). ```html Checked Unchecked Indeterminate ``` [Screenshot of vaadin-checkbox, using the default Lumo theme](https://vaadin.com/components/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`: ```sh bower i vaadin/vaadin-checkbox --save ``` Once installed, import it in your application: ```html ``` ### Polymer 3 and ES Modules Compatible Version Install `vaadin-checkbox`: ```sh npm i @vaadin/vaadin-checkbox --save ``` Once installed, import it in your application: ```js 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. 1. Make sure you have [npm](https://www.npmjs.com/) and [Bower](https://bower.io) installed. 1. When in the `vaadin-checkbox` directory, run `npm install` and then `bower install` to install dependencies. 1. Run `npm start`, 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: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](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. ## Big Thanks Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs](https://saucelabs.com). ## Contributing To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) 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.
Online Demo
Documentation
GitHub Homepage
Issue tracker
View on GitHub
View on NPM

vaadin-checkbox version 1.0.0-alpha1
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-alpha2
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-alpha3
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-alpha4
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-alpha5
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-alpha6
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-alpha7
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-alpha8
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0-beta1
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.0
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.1
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.2
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 1.0.3
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^1.0.0 * vaadin-themable-mixin#^1.1.0

vaadin-checkbox version 2.0.0-alpha1
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-valo-theme#^2.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-alpha2
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-valo-theme#^2.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-alpha3
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-valo-styles#vaadin/vaadin-valo-styles#^2.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-alpha4
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-valo-styles#vaadin/vaadin-valo-styles#^2.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-alpha5
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-valo-styles#vaadin/vaadin-valo-styles#^2.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-alpha6
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-alpha7
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-beta1
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-beta2
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-pre.1
### Dependencies * @polymer/polymer#^3.0.0-pre.12 * @vaadin/vaadin-control-state-mixin#^2.0.3-pre.1 * @vaadin/vaadin-element-mixin#^1.0.2-pre.1 * @vaadin/vaadin-lumo-styles#^1.0.0-pre.1 * @vaadin/vaadin-themable-mixin#^1.1.5-pre.1

vaadin-checkbox version 2.0.0
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.0.0-pre.2
### Dependencies * @polymer/polymer#^3.0.0-pre.12 * @vaadin/vaadin-control-state-mixin#^2.0.3-pre.1 * @vaadin/vaadin-themable-mixin#^1.1.5-pre.1 * @vaadin/vaadin-lumo-styles#^1.0.0-pre.1 * @vaadin/vaadin-element-mixin#^1.0.2-pre.1

vaadin-checkbox version 2.0.0-pre.3
### Dependencies * @polymer/polymer#^3.0.0-pre.13 * @vaadin/vaadin-control-state-mixin#^2.0.3-pre.2 * @vaadin/vaadin-themable-mixin#^1.1.5-pre.2 * @vaadin/vaadin-lumo-styles#^1.0.0-pre.4 * @vaadin/vaadin-element-mixin#^1.0.2-pre.2

vaadin-checkbox version 2.0.0-pre.4
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.0.3-pre.3 * @vaadin/vaadin-themable-mixin#^1.1.5-pre.3 * @vaadin/vaadin-lumo-styles#^1.0.0-pre.6 * @vaadin/vaadin-element-mixin#^1.0.2-pre.3

vaadin-checkbox version 2.1.0
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.1.1
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.2.0-alpha1
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-material-styles#vaadin/vaadin-material-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.2.0-alpha2
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.0-alpha2 * @vaadin/vaadin-element-mixin#^1.1.0-alpha1 * @vaadin/vaadin-lumo-styles#^1.1.0-alpha3 * @vaadin/vaadin-material-styles#^1.1.0-alpha2 * @vaadin/vaadin-themable-mixin#^1.2.0-alpha2

vaadin-checkbox version p3-preview
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#vaadin/vaadin-control-state-mixin#^2.1.0 * vaadin-themable-mixin#vaadin/vaadin-themable-mixin#^1.2.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.1.0 * vaadin-material-styles#vaadin/vaadin-material-styles#^1.1.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.1.0

vaadin-checkbox version 2.2.0-alpha3
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.0-alpha2 * @vaadin/vaadin-themable-mixin#^1.2.0-alpha2 * @vaadin/vaadin-lumo-styles#^1.1.0-alpha3 * @vaadin/vaadin-material-styles#^1.1.0-alpha2 * @vaadin/vaadin-element-mixin#^1.1.0-alpha1

vaadin-checkbox version 2.2.0-beta1
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.1.0-beta1 * @vaadin/vaadin-material-styles#^1.1.0-beta1 * @vaadin/vaadin-element-mixin#^1.1.2

vaadin-checkbox version 2.2.0-beta2
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.1.0-beta1 * @vaadin/vaadin-material-styles#^1.1.0-beta1 * @vaadin/vaadin-element-mixin#^1.1.2

vaadin-checkbox version 2.2.0
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#vaadin/vaadin-control-state-mixin#^2.1.1 * vaadin-themable-mixin#vaadin/vaadin-themable-mixin#^1.2.1 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.1.0-beta1 * vaadin-material-styles#vaadin/vaadin-material-styles#^1.1.0-beta1 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.2.1
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.1.0-beta1 * @vaadin/vaadin-material-styles#^1.1.0-beta1 * @vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.1.2
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.2.2
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.2.0 * @vaadin/vaadin-material-styles#^1.2.0 * @vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.2.3
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.2.0 * @vaadin/vaadin-material-styles#^1.2.0 * @vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.2.4
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.2.0 * @vaadin/vaadin-material-styles#^1.2.0 * @vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.1.3
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#^2.0.0 * vaadin-themable-mixin#^1.1.0 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^1.0.1

vaadin-checkbox version 2.2.5
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.2.0 * @vaadin/vaadin-material-styles#^1.2.0 * @vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.2.6
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.2.0 * @vaadin/vaadin-material-styles#^1.2.0 * @vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.2.7
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-control-state-mixin#^2.1.1 * @vaadin/vaadin-themable-mixin#^1.2.1 * @vaadin/vaadin-lumo-styles#^1.2.0 * @vaadin/vaadin-material-styles#^1.2.0 * @vaadin/vaadin-element-mixin#^2.0.0

vaadin-checkbox version 2.2.8
### Dependencies * polymer#^2.0.0 * vaadin-control-state-mixin#vaadin/vaadin-control-state-mixin#^2.1.1 * vaadin-themable-mixin#vaadin/vaadin-themable-mixin#^1.2.1 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.2.0 * vaadin-material-styles#vaadin/vaadin-material-styles#^1.2.0 * vaadin-element-mixin#vaadin/vaadin-element-mixin#^2.0.0

Online