Checkbox webcomponent with hand-drawn look.

[ This description is mirrored from README.md at github.com/wiredjs/wired-checkbox on 2019-05-10 ]

wired checkbox

wired-checkbox

Hand-drawn sketchy checkbox web component.

For demo and view the complete set of wired-elememts: wiredjs.com

Learn about web components here.

Usage

Add wired-checkbox to your project:

npm i wired-checkbox

Import wired-checkbox definition into your HTML page:

<script type="module" src="wired-checkbox/wired-checkbox.js"></script>

Or into your module script:

import { WiredCheckbox } from "wired-checkbox"

Use it in your web page:

<wired-checkbox text="Checkbox One"></wired-checkbox>
<wired-checkbox text="Checkbox Two" checked></wired-checkbox>
<wired-checkbox text="Checkbox disabled" disabled></wired-checkbox>

Properties

checked - Checked state (boolean). Default is false.

disabled - disables the checkbox. Default value is false.

text - Text associated with the checkbox.

Custom CSS Variables

--wired-checkbox-icon-color Color of the checkbox. Default is currentColor.

Events

change event fired when state of the checkbox changes, i.e. the user checks/unchecks the box.

Install

Link to this version
ImportedReleased 18 September 2017MIT License
Framework Support
Polymer 2.0+
Browser Compatibility
Install with
bower install --save wiredjs/wired-checkbox"#0.2.1"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 0.2.1

Dependencies

  • polymer#Polymer/polymer#^2.0.0
  • wired-lib#^0.1.0