Class yii\jui\Sortable

Inheritance	yii\jui\Sortable » yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-jui/blob/master/Sortable.php

Sortable renders a sortable jQuery UI widget.

For example:

echo Sortable::widget([
    'items' => [
        'Item 1',
        ['content' => 'Item2'],
        [
            'content' => 'Item3',
            'options' => ['tag' => 'li'],
        ],
    ],
    'options' => ['tag' => 'ul'],
    'itemOptions' => ['tag' => 'li'],
    'clientOptions' => ['cursor' => 'move'],
]);

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

Public Properties

Property	Type	Description	Defined By
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\base\Widget
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$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
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$id	string	ID of the widget.	yii\base\Widget
$itemOptions	array	List of HTML attributes for the item container tags.	yii\jui\Sortable
$items	array	List of sortable items.	yii\jui\Sortable
$options	array	The HTML attributes for the widget container tag.	yii\jui\Sortable
$stack	yii\base\Widget[]	The widgets that are currently being rendered (not ended).	yii\base\Widget
$view	yii\web\View	The view object that can be used to render views or view files.	yii\base\Widget
$viewPath	string	The directory containing the view files for this widget.	yii\base\Widget

Protected Properties

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

Public Methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
afterRun()	This method is invoked right after a widget is executed.	yii\base\Widget
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeRun()	This method is invoked right before the widget is executed.	yii\base\Widget
begin()	Begins a widget.	yii\base\Widget
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
end()	Ends a widget.	yii\base\Widget
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getId()	Returns the ID of the widget.	yii\base\Widget
getView()	Returns the view object that can be used to render views or view files.	yii\base\Widget
getViewPath()	Returns the directory containing the view files for this widget.	yii\base\Widget
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the widget.	yii\jui\Widget
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
render()	Renders a view.	yii\base\Widget
renderFile()	Renders a view file.	yii\base\Widget
renderItems()	Renders sortable items as specified on $items.	yii\jui\Sortable
run()	Renders the widget.	yii\jui\Sortable
setId()	Sets the ID of the widget.	yii\base\Widget
setView()	Sets the view object to be used by this widget.	yii\base\Widget
trigger()	Triggers an event.	yii\base\Component
widget()	Creates a widget instance and runs it.	yii\base\Widget

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

Events

Event	Type	Description	Defined By
EVENT_AFTER_RUN	yii\base\WidgetEvent	An event raised right after executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_BEFORE_RUN	yii\base\WidgetEvent	An event raised right before executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_INIT	yii\base\Event	An event that is triggered when the widget is initialized via init(). (available since version 2.0.11)	yii\base\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' => 'sortactivate', 'beforeStop' => 'sortbeforestop', 'change' => 'sortchange', 'create' => 'sortcreate', 'deactivate' => 'sortdeactivate', 'out' => 'sortout', 'over' => 'sortover', 'receive' => 'sortreceive', 'remove' => 'sortremove', 'sort' => 'sort', 'start' => 'sortstart', 'stop' => 'sortstop', 'update' => 'sortupdate']

$itemOptions public property

List of HTML attributes for the item container tags. This will be overwritten by the "options" set in individual $items. The following special options are recognized:

• tag: string, defaults to "li", the tag name of the item container tags.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $itemOptions = []

$items public property

List of sortable items. Each item can be a string representing the item content or an array of the following structure:

[
    'content' => 'item content',
    // the HTML attributes of the item container tag. This will overwrite "itemOptions".
    'options' => [],
]

public array $items = []

$options public property

The HTML attributes for the widget container tag. The following special options are recognized:

• tag: string, defaults to "ul", the tag name of the container tag of this widget.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = []

Method Details