riot-md-checkbox
Material Design animated Checkbox input, for Riot.js
Installation
bower install riot-md-checkbox
or
npm install riot-md-checkbox
Usage
Bower
With Bower, you have access to the pre-compiled and non-compiled files.
Pre-compiled:
<!-- mount point --> <!-- include riot.js only --><!-- include the precompiled js file --><!-- standard `mount()` -->
In-browser Compilation:
<!-- mount point --> <!-- include source tag --><!-- include riot.js and the compiler --><!-- standard `mount()` -->
NPM
A pre-compiled version, including styles, is exported as the NPM module. This means you may require()
the module directly.
// templates.js (example file)var riot = ; ; riot;
Note: You do not need to require
riot
within the same file. However,riot
must be loaded and accessible before your template file(s) -- a simple global will work.
Options
input
Type:
string
Default:null
Required:false
Serves as both the id
and name
attributes of your <input />
element.
check
Type:
string
Default:null
Required:false
Sets the checked
attribute. Passing any string will be handled as true
!
value
Type:
string
Default:1
Required:false
The value
of the input when checked.
label
Type:
string
Default:null
Required:false
The main label / text for your input.
text
Type:
string
Default:null
Required:false
Additional text to display; appears within a <small>
element.
ontoggle
Type:
function
Default:null
Required:false
An additional callback when toggling a checkbox, regardless of checked
status.
License
MIT © Luke Edwards