Class yii\jui\Tabs
Inheritance | yii\jui\Tabs » 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/Tabs.php |
Tabs renders a tabs jQuery UI widget.
For example:
echo Tabs::widget([ 'items' => [ [ 'label' => 'Tab one', 'content' => 'Mauris mauris ante, blandit et, ultrices a, suscipit eget...', ], [ 'label' => 'Tab two', 'content' => 'Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus...', 'options' => ['tag' => 'div'], 'headerOptions' => ['class' => 'my-class'], ], [ 'label' => 'Tab with custom id', 'content' => 'Morbi tincidunt, dui sit amet facilisis feugiat...', 'options' => ['id' => 'my-tab'], ], [ 'label' => 'Ajax tab', 'url' => ['ajax/content'], ], ], 'options' => ['tag' => 'div'], 'itemOptions' => ['tag' => 'div'], 'headerOptions' => ['class' => 'my-class'], 'clientOptions' => ['collapsible' => false], ]);
See also http://api.jqueryui.com/tabs/.
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 |
$encodeLabels | boolean | Whether the labels for header items should be HTML-encoded. | yii\jui\Tabs |
$headerOptions | array | List of HTML attributes for the header container tags. | yii\jui\Tabs |
$id | string | ID of the widget. | yii\base\Widget |
$itemOptions | array | List of HTML attributes for the item container tags. | yii\jui\Tabs |
$items | array | List of tab items. | yii\jui\Tabs |
$linkTemplate | string | The default header template to render the link. | yii\jui\Tabs |
$options | array | The HTML attributes for the widget container tag. | yii\jui\Tabs |
$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\Widget |
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 |
run() | Renders the widget. | yii\jui\Tabs |
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 |
renderItems() | Renders tab items as specified on $items. | yii\jui\Tabs |
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
$encodeLabels public property
Whether the labels for header items should be HTML-encoded.
public boolean $encodeLabels = true
$headerOptions public property
List of HTML attributes for the header container tags. This will be overwritten by the "headerOptions" set in individual $items.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
public array $headerOptions = []
$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 "div", 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 tab items. Each item can be an array of the following structure:
- label: string, required, specifies the header link label. When $encodeLabels is true, the label will be HTML-encoded.
- content: string, the content to show when corresponding tab is clicked. Can be omitted if url is specified.
- url: mixed, mixed, optional, the url to load tab contents via AJAX. It is required if no content is specified.
- template: string, optional, the header link template to render the header link. If none specified $linkTemplate will be used instead.
- options: array, optional, the HTML attributes of the header.
- headerOptions: array, optional, the HTML attributes for the header container tag.
public array $items = []
$linkTemplate public property
The default header template to render the link.
public string $linkTemplate = '<a href="{url}">{label}</a>'
$options public property
The HTML attributes for the widget container tag. The following special options are recognized:
- tag: string, defaults to "div", 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
renderItems() protected method
Renders tab items as specified on $items.
protected string renderItems ( ) | ||
---|---|---|
return | string |
The rendering result. |
throws | \yii\jui\InvalidConfigException. |
run() public method
Renders the widget.
public void run ( ) |
---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-jui-tabs.html