A customizable checkbox control.

[ This description is mirrored from README.md at github.com/arsnebula/nebula-checkbox on 2019-05-22 ]

Published on webcomponents.org Polymer Version Sauce Labs Build Status Gitter Chat Become a Patreon

<nebula-checkbox>

A customizable checkbox control.

  • Elegant ghost-style checkbox control
  • Customizable icons for unchecked and checked states
  • Easily customized using CSS variables and mixins
  • Supports WAI-ARIA authoring practices for a11y

Installation

$ bower install -S arsnebula/nebula-checkbox

Getting Started

Import the element.

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

Add the element.

<nebula-checkbox
  checked="{{checked}}"
  on-checked-changed="_onCheckedChanged">
</nebula-checkbox>

Style the element.

nebula-checkbox {
  --nebula-checkbox-color: teal;
  --nebula-checkbox-size: 1.5rem;
}

For more information, see the API Reference documentation.

Contributing

We welcome and appreciate feedback from the community. Here are a few ways that you can show your appreciation for this package:

  • Give us a Star on GitHub from either webcomponents.org or directly on GitHub.

  • Submit a feature request, or a defect report on the Issues List.

  • Become a Patreon. It takes a lot of time and effort to develop, document, test and support the elements in our Nebula Essentials collection. Your financial contribution will help ensure that our entire collection continues to grow and improve.

If you are a developer, and are interested in making a code contribution, consider opening an issue first to describe the change, and discuss with the core repository maintainers. Once you are ready, prepare a pull request:

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Change Log

See CHANGELOG

License

See LICENSE

Install

Link to this version
ImportedReleased 22 May 2017ISC License
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (2.0.0)
Browser Compatibility
Install with
bower install --save arsnebula/nebula-checkbox"#2.0.1"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.0.1

Dependencies

  • polymer#Polymer/polymer#^2.0.0
  • nebula-focus-behavior#arsnebula/nebula-focus-behavior#^2.0.0
  • nebula-checked-behavior#arsnebula/nebula-checked-behavior#^2.0.0
  • nebula-icons#arsnebula/nebula-icons#^2.0.0
  • nebula-element-mixin#arsnebula/nebula-element-mixin#^2.0.0