ractive-component-toggle v0.1.1

ractive-component-toggle

Ractive component wrapping bootstrap toggle widget: http://www.bootstraptoggle.com/

Installation

$ npm install ractive-component-toggle

Note that to use this component you must have Ractive (either via <script src="..."> or bundled using e.g. browserify) and bootstrap styles available.

If you've made some changes to source files, please rebuild bundle.js with the following command

$ npm install  # installs dev-dependencies
$ npm run build

If your application uses CommonJS approach (browserify) add

require('ractive-component-toggle');

to your code.

Usage

Please look at demo.html for usage example.

Basically you use the <Toggle/> tag in your template and configure it using the following attributes:

• value Specifies the variable containing the state of toggle: value='{{toggle_var}}'.
• texton (default: 'On') Text displayed when toggle is on.
• textoff (default: 'Off') Text displayed when toggle is off.
• size (default: 'normal') One of predefined sizes (the same as in original bootstraptoggle): 'large', 'normal', 'small', 'mini'.
• styleon (default: 'btn-primary') CSS class applied to the texton label.
• styleoff (default: 'btn-default') CSS class applied to the textoff label.
• handle (default: 'btn-default') CSS class applied to handle.
• custom_style CSS string put into the style attribute of wrapping <div>. Allows to make toggle wider if your label is too long for instance.

License

MIT