Class yii\bootstrap\ButtonGroup

All Classes | Properties | Methods

Inheritance	yii\bootstrap\ButtonGroup » yii\bootstrap\Widget » yii\base\Widget
Uses Traits	yii\bootstrap\BootstrapWidgetTrait
Available since version	2.0

ButtonGroup renders a button group bootstrap component.

For example,

// a button group with items configuration
echo ButtonGroup::widget([
    'buttons' => [
        ['label' => 'A'],
        ['label' => 'B'],
        ['label' => 'C', 'visible' => false],
    ]
]);

// button group with an item as a string
echo ButtonGroup::widget([
    'buttons' => [
        Button::widget(['label' => 'A']),
        ['label' => 'B'],
    ]
]);

Pressing on the button should be handled via JavaScript. See the following for details:

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$buttons	array	List of buttons.	yii\bootstrap\ButtonGroup
$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
$encodeLabels	boolean	Whether to HTML-encode the button labels.	yii\bootstrap\ButtonGroup
$options	array	The HTML attributes for the widget container tag.	yii\bootstrap\Widget

Public Methods

Hide inherited methods

Method	Description	Defined By
getView()		yii\bootstrap\BootstrapWidgetTrait
init()	Initializes the widget.	yii\bootstrap\ButtonGroup
run()	Renders the widget.	yii\bootstrap\ButtonGroup

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
renderButtons()	Generates the buttons that compound the group as specified on $buttons.	yii\bootstrap\ButtonGroup

Property Details

$buttons public property

List of buttons. Each array element represents a single button which can be specified as a string or an array of the following structure:

label: string, required, the button label.
options: array, optional, the HTML attributes of the button.
visible: bool, optional, whether this button is visible. Defaults to true.

public array $buttons = []

$encodeLabels public property

Whether to HTML-encode the button labels.

public boolean $encodeLabels = true

Method Details

init() public method

Initializes the widget.

If you override this method, make sure you call the parent implementation first.

public void init ( )

renderButtons() protected method

Generates the buttons that compound the group as specified on $buttons.

protected string renderButtons ( )
return	string	The rendering result.

run() public method

Renders the widget.

public void run ( )