Class yii\bootstrap\ButtonDropdown
| Inheritance | yii\bootstrap\ButtonDropdown » yii\bootstrap\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-bootstrap/blob/master/ButtonDropdown.php |
ButtonDropdown renders a group or split button dropdown bootstrap component.
For example,
// a button group using Dropdown widget
echo ButtonDropdown::widget([
'label' => 'Action',
'dropdown' => [
'items' => [
['label' => 'DropdownA', 'url' => '/'],
['label' => 'DropdownB', 'url' => '#'],
],
],
]);See also:
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 Bootstrap JS plugin. | yii\bootstrap\Widget |
| $clientOptions | array | The options for the underlying Bootstrap JS plugin. | yii\bootstrap\Widget |
| $containerOptions | array | The HTML attributes for the container tag. | yii\bootstrap\ButtonDropdown |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $dropdown | array | The configuration array for yii\bootstrap\Dropdown. | yii\bootstrap\ButtonDropdown |
| $encodeLabel | boolean | Whether the label should be HTML-encoded. | yii\bootstrap\ButtonDropdown |
| $id | string | ID of the widget. | yii\base\Widget |
| $label | string | The button label | yii\bootstrap\ButtonDropdown |
| $options | array | The HTML attributes of the button. | yii\bootstrap\ButtonDropdown |
| $split | boolean | Whether to display a group of split-styled button group. | yii\bootstrap\ButtonDropdown |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $tagName | string | The tag to use to render the button | yii\bootstrap\ButtonDropdown |
| $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 |
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 |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| 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\bootstrap\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\bootstrap\ButtonDropdown |
| 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 JS event handlers that are listed in $clientEvents. | yii\bootstrap\Widget |
| registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap\Widget |
| renderButton() | Generates the button dropdown. | yii\bootstrap\ButtonDropdown |
| renderDropdown() | Generates the dropdown menu. | yii\bootstrap\ButtonDropdown |
Property Details
The HTML attributes for the container tag. The following special options are recognized:
- tag: string, defaults to "div", the name of the container tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The configuration array for yii\bootstrap\Dropdown.
Whether the label should be HTML-encoded.
The button label
The HTML attributes of the button.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
Whether to display a group of split-styled button group.
The tag to use to render the button
Method Details
Generates the button dropdown.
| string renderButton( ) | ||
| return | string | The rendering result. |
|---|---|---|
Generates the dropdown menu.
| string renderDropdown( ) | ||
| return | string | The rendering result. |
|---|---|---|
Renders the widget.
| void run( ) |