Class yii\bootstrap\ButtonDropdown

All Classes | Properties | Methods | Events

Inheritance	yii\bootstrap\ButtonDropdown » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	yii\bootstrap\BootstrapWidgetTrait
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' => '#'],
        ],
    ],
]);

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 Bootstrap JS plugin.	yii\bootstrap\BootstrapWidgetTrait
$clientOptions	array	The options for the underlying Bootstrap JS plugin.	yii\bootstrap\BootstrapWidgetTrait
$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
$dropdownClass	string	Name of a class to use for rendering dropdowns withing this widget.	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\bootstrap\BootstrapWidgetTrait
$viewPath	string	The directory containing the view files for this widget.	yii\base\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\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\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()		yii\bootstrap\BootstrapWidgetTrait
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\bootstrap\BootstrapWidgetTrait
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

Hide inherited methods

Method	Description	Defined By
registerClientEvents()	Registers JS event handlers that are listed in $clientEvents.	yii\bootstrap\BootstrapWidgetTrait
registerPlugin()	Registers a specific Bootstrap plugin and the related events	yii\bootstrap\BootstrapWidgetTrait
renderButton()	Generates the button dropdown.	yii\bootstrap\ButtonDropdown
renderDropdown()	Generates the dropdown menu.	yii\bootstrap\ButtonDropdown

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

Property Details

$containerOptions public property (available since version 2.0.1)

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.

public array $containerOptions = []

The configuration array for yii\bootstrap\Dropdown.

public array $dropdown = []

$dropdownClass public property (available since version 2.0.7)

Name of a class to use for rendering dropdowns withing this widget. Defaults to yii\bootstrap\Dropdown.

public string $dropdownClass = 'yii\bootstrap\Dropdown'

$encodeLabel public property

Whether the label should be HTML-encoded.

public boolean $encodeLabel = true

$label public property

The button label

public string $label = 'Button'

$options public property

The HTML attributes of the button.

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

public array $options = []

$split public property

Whether to display a group of split-styled button group.

public boolean $split = false

$tagName public property

The tag to use to render the button

public string $tagName = 'button'

Method Details

renderButton() protected method

Generates the button dropdown.

protected string renderButton ( )
return	string	The rendering result.

renderDropdown() protected method

Generates the dropdown menu.

protected string renderDropdown ( )
return	string	The rendering result.

run() public method

Renders the widget.

public void run ( )