Class yii\bootstrap\ButtonDropdown

Inheritanceyii\bootstrap\ButtonDropdown » yii\bootstrap\Widget » yii\base\Widget
Uses Traitsyii\bootstrap\BootstrapWidgetTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2-bootstrap/blob/master/src/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

Hide inherited properties

PropertyTypeDescriptionDefined By
$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
$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
$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
$tagName string The tag to use to render the button yii\bootstrap\ButtonDropdown

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getView() yii\bootstrap\BootstrapWidgetTrait
init() Initializes the widget. yii\bootstrap\BootstrapWidgetTrait
run() Renders the widget. yii\bootstrap\ButtonDropdown

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

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.

$dropdown public property

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 ( )