kartik-v / yii2-widget-switchinput

A Yii2 wrapper widget for the Bootstrap Switch plugin to use checkboxes & radios as toggle switches (sub repo split from yii2-widgets)
Other
38 stars 11 forks source link

yii2-widget-switchinput

Latest Stable Version License Total Downloads Monthly Downloads Daily Downloads

The SwitchInput widget turns checkboxes and radio buttons into toggle switchinputes. The plugin is a wrapper for the Bootstrap Switch Plugin and is specially styled for Bootstrap 3.

NOTE: This extension is a sub repo split of yii2-widgets. The split has been done since 08-Nov-2014 to allow developers to install this specific widget in isolation if needed. One can also use the extension the previous way with the whole suite of yii2-widgets.

Installation

The preferred way to install this extension is through composer. Check the composer.json for this extension's requirements and dependencies. Read this web tip /wiki on setting the minimum-stability settings for your application's composer.json.

To install, either run

$ php composer.phar require kartik-v/yii2-widget-switchinput "*"

or add

"kartik-v/yii2-widget-switchinput": "*"

to the require section of your composer.json file.

Latest Release

NOTE: The latest version of the module is v1.3.0 released on 14-Jan-2015. Refer the CHANGE LOG for details.

Demo

You can refer detailed documentation and demos on usage of the extension.

Usage

use kartik\switchinput\SwitchInput;

// Usage with ActiveForm and model
echo $form->field($model, 'status')->widget(SwitchInput::classname(), [
    'type' => SwitchInput::CHECKBOX
]);

// With model & without ActiveForm
echo SwitchInput::widget([
    'name' => 'status_1',
    'type' => SwitchInput::RADIO
]);

License

yii2-widget-switchinput is released under the BSD 3-Clause License. See the bundled LICENSE.md for details.