yii2-widget-switchery's Introduction

yii2-widget-switchery

iOS Switchery Slider (http://abpetkov.github.io/switchery/)

Installation

The preferred way to install this extension is through composer. Check the composer.json for this extension's requirements and dependencies.

To install, either run

$ php composer.phar require toxor88/yii2-widget-switchery "*"

or add

"toxor88/yii2-widget-switchery": "*"

to the require section of your composer.json file.

Demo

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

Usage

use toxor88\switchery\Switchery;
use yii\web\JsExpression;

// usage without model
echo '<label>Can do something?</label>';
echo Switchery::widget([
	'name' => 'can_do_something', 
	'clientOptions' => [
		'color'              => '#64bd63',
		'secondaryColor'     => '#dfdfdf',
        'jackColor'          => '#fff',
        'jackSecondaryColor' => null,
        'className'          => 'switchery',
        'disabled'           => false,
        'disabledOpacity'    => 0.5,
        'speed'              => '0.1s',
        'size'               => 'default',
	],
    'clientChangeEvent' => new JsExpression('function() {
        alert("checked: " + this.checked);
    }'),
]);

// usage with model
$form->model($model, 'attribute')->widget(Switchery::className(), [ /* widget options... */ ]);

// if you use the defualt ActiveField template, there can be multiple labels. To avoid it use:
// the label displays after the slider:
$form->model($model, 'attribute')->widget(Switchery::className(), [ /* widget options... */ ])->label(false);

// the label displays before the slider:
$form->model($model, 'attribute')->widget(Switchery::className(), [ 'options' => 'label' => null ])->label('label text or inherited from model');