Class yii\jui\Droppable
Inheritance | yii\jui\Droppable » yii\jui\Widget » yii\base\Widget |
---|---|
Available since version | 2.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
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 |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$clientEventMap | array | Event names mapped to what should be specified in `. | yii\jui\Droppable |
Public Methods
Method | Description | Defined By |
---|---|---|
init() | Initializes the widget. | yii\jui\Droppable |
run() | Renders the widget. | yii\jui\Droppable |
Protected Methods
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 |
Property Details
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']