Class yii\jui\Draggable

All Classes | Properties | Methods

Inheritance	yii\jui\Draggable » yii\jui\Widget » yii\base\Widget
Available since version	2.0

Draggable renders an draggable jQuery UI widget.

For example:

Draggable::begin([
    'clientOptions' => ['grid' => [50, 20]],
]);

echo 'Draggable contents here...';

Draggable::end();

Public Properties

Property	Type	Description	Defined By
$clientEvents	array	The event handlers for the underlying jQuery UI widget.	yii\jui\Widget
$clientOptions	array	The options for the underlying jQuery UI widget.	yii\jui\Widget
$options	array	The HTML attributes for the widget container tag.	yii\jui\Widget

Property	Type	Description	Defined By
$clientEventMap	array	Event names mapped to what should be specified in `.	yii\jui\Draggable

Method	Description	Defined By
init()	Initializes the widget.	yii\jui\Draggable
run()	Renders the widget.	yii\jui\Draggable

Method	Description	Defined By
registerClientEvents()	Registers a specific jQuery UI widget events	yii\jui\Widget
registerClientOptions()	Registers a specific jQuery UI widget options	yii\jui\Widget
registerWidget()	Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events	yii\jui\Widget

$clientEventMap protected property

Event names mapped to what should be specified in .on(). If empty, it is assumed that event passed to clientEvents is prefixed with widget name.

protected array $clientEventMap = ['create' => 'dragcreate', 'drag' => 'drag', 'stop' => 'dragstop', 'start' => 'dragstart']

init() public method

Initializes the widget.

public void init ( )

run() public method

Renders the widget.

public void run ( )