Class yii\jui\Selectable

All Classes | Properties | Methods | Events | Constants

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

Selectable renders a selectable jQuery UI widget.

For example:

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

Selectable in begin mode.

Selectable::begin([
    'clientOptions' => [
        'filter' => 'my-selectable-item',
        'tolerance' => 'touch',
    ],
]);

Item 1
Item 2
Item 3
Item 4

Another item

Selectable::end();

Public Properties

Hide inherited 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\|null	ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details.	yii\base\Widget
$itemOptions	array	List of HTML attributes for the item container tags.	yii\jui\Selectable
$items	array	List of selectable items.	yii\jui\Selectable
$mode	string	The mode used to render the widget.	yii\jui\Selectable
$options	array	The HTML attributes for the widget container tag.	yii\jui\Selectable
$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. Note that the type of this property differs in getter and setter. See getView() and setView() for details.	yii\base\Widget
$viewPath	string	The directory containing the view files for this widget.	yii\base\Widget

Protected Properties

Hide inherited properties

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

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
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\jui\Selectable
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\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
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\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the widget.	yii\jui\Selectable
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 selectable items as specified on $items.	yii\jui\Selectable
run()	Renders the widget.	yii\jui\Selectable
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

Hide inherited 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

Hide inherited 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

Constants

Hide inherited constants

Constant	Value	Description	Defined By
MODE_BEGIN	'MODE_BEGIN'		yii\jui\Selectable
MODE_DEFAULT	'MODE_DEFAULT'		yii\jui\Selectable

Property Details

$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 selectable 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 = []

$mode public property

The mode used to render the widget.

public string $mode = self::MODE_DEFAULT

$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

begin() public static method

Begins a widget.

This method creates an instance of the calling class setting the MODE_BEGIN mode. Any item between begin() and end() which match the filter attribute, will be selectable. It will apply the configuration to the created instance. A matching end() call should be called later. As some widgets may use output buffering, the end() call should be made in the same view to avoid breaking the nesting of output buffers.

public static static begin ( $config = [] )
$config	array	Name-value pairs that will be used to initialize the object properties
return	static	The newly created widget instance

public string renderItems ( )
return	string	The rendering result.
throws	\yii\jui\InvalidConfigException.