Class yii\bootstrap4\Breadcrumbs
Breadcrumbs represents a bootstrap 4 version of yii\widgets\Breadcrumbs. It displays a list of links indicating the position of the current page in the whole site hierarchy.
To use Breadcrumbs, you need to configure its $links property, which specifies the links to be displayed. For example,
echo Breadcrumbs::widget([
'links' => isset($this->params['breadcrumbs']) ? $this->params['breadcrumbs'] : [],
'options' => [],
]);
See also https://getbootstrap.com/docs/4.5/components/breadcrumb/.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $activeItemTemplate | string | The template used to render each active item in the breadcrumbs. | yii\bootstrap4\Breadcrumbs |
| $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\bootstrap4\BootstrapWidgetTrait |
| $clientOptions | array | The options for the underlying Bootstrap JS plugin. | yii\bootstrap4\BootstrapWidgetTrait |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $encodeLabels | boolean | Whether to HTML-encode the link labels. | yii\bootstrap4\Breadcrumbs |
| $homeLink | array | The first hyperlink in the breadcrumbs (called home link). | yii\bootstrap4\Breadcrumbs |
| $id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget |
| $itemTemplate | string | The template used to render each inactive item in the breadcrumbs. | yii\bootstrap4\Breadcrumbs |
| $links | array | List of links to appear in the breadcrumbs. | yii\bootstrap4\Breadcrumbs |
| $navOptions | array | The HTML attributes for the widgets nav container tag. | yii\bootstrap4\Breadcrumbs |
| $options | array | The HTML attributes for the widget container tag. | yii\bootstrap4\Widget |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $tag | string | The name of the breadcrumb container tag. | yii\bootstrap4\Breadcrumbs |
| $view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
Public 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\bootstrap4\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\bootstrap4\Breadcrumbs |
| 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\bootstrap4\Breadcrumbs |
| 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
| Method | Description | Defined 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 |
| renderItem() | Renders a single breadcrumb item. | yii\bootstrap4\Breadcrumbs |
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
The template used to render each active item in the breadcrumbs. The token {link}
will be replaced with the actual HTML link for each active item.
Whether to HTML-encode the link labels.
The first hyperlink in the breadcrumbs (called home link). Please refer to $links on the format of the link. If this property is not set, it will default to a link pointing to yii\web\Application::$homeUrl with the label 'Home'. If this property is false, the home link will not be rendered.
The template used to render each inactive item in the breadcrumbs. The token {link}
will be replaced with the actual HTML link for each inactive item.
List of links to appear in the breadcrumbs. If this property is empty, the widget will not render anything. Each array element represents a single link in the breadcrumbs with the following structure:
[
'label' => 'label of the link', // required
'url' => 'url of the link', // optional, will be processed by Url::to()
'template' => 'own template of the item', // optional, if not set $this->itemTemplate will be used
]
The HTML attributes for the widgets nav container tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The name of the breadcrumb container tag.
Method Details
Initializes the widget.
If you override this method, make sure you call the parent implementation first.
| public void init ( ) |
Renders a single breadcrumb item.
| protected string renderItem ( $link, $template ) | ||
| $link | array | The link to be rendered. It must contain the "label" element. The "url" element is optional. |
| $template | string | The template to be used to rendered the link. The token "{link}" will be replaced by the link. |
| return | string | The rendering result |
|---|---|---|
| throws | yii\base\InvalidConfigException | if |
Renders the widget.
| public void run ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|