Class yii\bootstrap4\Button

Inheritanceyii\bootstrap4\Button » yii\bootstrap4\Widget » yii\base\Widget
Uses Traitsyii\bootstrap4\BootstrapWidgetTrait
Source Code https://github.com/yiisoft/yii2-bootstrap4/blob/master/src/Button.php

Button renders a bootstrap button.

For example,

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

See also https://getbootstrap.com/docs/4.5/components/buttons/.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$clientEvents array The event handlers for the underlying Bootstrap JS plugin. yii\bootstrap4\BootstrapWidgetTrait
$clientOptions array The options for the underlying Bootstrap JS plugin. yii\bootstrap4\BootstrapWidgetTrait
$encodeLabel boolean Whether the label should be HTML-encoded. yii\bootstrap4\Button
$label string The button label yii\bootstrap4\Button
$options array The HTML attributes for the widget container tag. yii\bootstrap4\Widget
$tagName string The tag to use to render the button yii\bootstrap4\Button

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
registerClientEvents() Registers JS event handlers that are listed in $clientEvents. yii\bootstrap4\BootstrapWidgetTrait
registerPlugin() Registers a specific Bootstrap plugin and the related events yii\bootstrap4\BootstrapWidgetTrait

Property Details

$encodeLabel public property

Whether the label should be HTML-encoded.

public boolean $encodeLabel true
$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'

Method Details

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

public void run ( )