Class yii\jui\Droppable

Inheritanceyii\jui\Droppable » yii\jui\Widget » yii\base\Widget
Available since version2.0

Droppable renders an droppable jQuery UI widget.

For example:

Droppable::begin([
    'clientOptions' => ['accept' => '.special'],
]);

echo 'Droppable body here...';

Droppable::end();

See also http://api.jqueryui.com/droppable/.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$clientEventMap array Event names mapped to what should be specified in `. yii\jui\Droppable

Public Methods

Hide inherited methods

MethodDescriptionDefined By
init() Initializes the widget. yii\jui\Droppable
run() Renders the widget. yii\jui\Droppable

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

Property Details

$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 = ['activate' => 'dropactivate''create' => 'dropcreate''deactivate' => 'dropdeactivate''drop' => 'drop''out' => 'dropout''over' => 'dropover']

Method Details

init() public method

Initializes the widget.

public void init ( )
run() public method

Renders the widget.

public void run ( )