README.md

Installation

With NPM:

npm install checkboxes.js --save

With bower:

bower install checkboxes --save

Manually:

1. Download the latest release.
2. Then include jquery.checkboxes-###.min.js just after jQuery.

Features

• Check all checkboxes in context.
• Uncheck all checkboxes in context.
• Toggle states of all checkboxes in context.
• Enable range selection.
• Limit the number of checked checkbox per context.
• Data API like Twitter Bootstrap.

Documentation and examples

• Checking all checkboxes in a context
• Unchecking all checkboxes in a context
• Toggling all checkboxes's state in a context
• Enabling range selection of checkboxes
• Limiting the number of checked checkboxes in a context

Want to contribute?

All help are more than welcome!

Pre-requisites

• node.js.
• Grunt.
• Bower.

Development Workflow

1. Fork this respository.

2. Clone your fork and create a feature branch from develop.

   git clone [email protected]:<your-username>/checkboxes.js.git
   git fetch origin
   git checkout develop
   git checkout -b feature-<super-power>

3. Install development dependencies.

   npm install
   bower install

4. Code and be happy!

5. Test your code (run grunt to watch JS files and execute the test specs).

6. When everything is in good shape prepare the distribution files (run grunt build).

7. Submit a pull request and grab popcorn.

Questions? Hit me.

ProTip:

When coding run grunt, this will watch for any change in source and test files, then it will lint and test your code as you code.

Tests

To run all tests:

grunt test

Credits

• checkboxes.js was created by Rubens Mariuzzo with all the love in the world.

• checkboxes.js would not have been possible without the help of: jQuery, Highlight.js, Font Awesome, Glyphicons, Twitter Bootstrap and Subtle Patterns. I'm very thankful for all!

Used by

• Patchwork