Class yii\bootstrap\Button

All Classes | Properties | Methods

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

Button renders a bootstrap button.

For example,

echo Button::widget([
    'label' => 'Action',
    'options' => ['class' => 'btn-lg'],
]);

Public Properties

Property	Type	Description	Defined 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
$encodeLabel	boolean	Whether the label should be HTML-encoded.	yii\bootstrap\Button
$label	string	The button label	yii\bootstrap\Button
$options	array	The HTML attributes for the widget container tag.	yii\bootstrap\Widget
$tagName	string	The tag to use to render the button	yii\bootstrap\Button

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

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

$encodeLabel public property

Whether the label should be HTML-encoded.

$label public property

The button label

public string $label = 'Button'

$tagName public property

The tag to use to render the button

public string $tagName = 'button'

init() public method

Initializes the widget.

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

public void init ( )

run() public method

Renders the widget.

public void run ( )