Breadcrumbs

API reference › Bootstrap 6 › Breadcrumbs

class	`yii2\extensions\bootstrap6\Breadcrumbs`
Extends	`Widget` » `yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Uses traits	`AttributesTrait`, `BootstrapWidgetTrait`
Source	`src/Breadcrumbs.php`

Renders a Bootstrap breadcrumb trail with explicit .breadcrumb-divider elements between the items.

Items without a url (or with active set to true) are rendered with $activeItemTemplate and an active .breadcrumb-link.

Properties

Property	Type	Description	Defined by
`$activeItemTemplate`	`string`	Template of the active item; `{link}` is replaced by the rendered link. Default: `"<li class=\"breadcrumb-item\" aria-current=\"page\">{link}</li>\n"`.	`Breadcrumbs`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$clientEvents`	`array<string,` `yii\web\JsExpression\|string>`	Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`.	`BootstrapWidgetTrait`
`$clientOptions`	`array<string, mixed>\|false`	Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`.	`BootstrapWidgetTrait`
`$divider`	`string`	Content of every divider element; it is not HTML-encoded. An empty `string` renders the default chevron. Default: `''`.	`Breadcrumbs`
`$dividerOptions`	`array<string, mixed>`	HTML attributes of every divider tag. Default: `['class' => 'breadcrumb-divider']`.	`Breadcrumbs`
`$encodeLabels`	`bool`	Whether to HTML-encode the link labels; an item `encode` key overrides it. Default: `true`.	`Breadcrumbs`
`$homeLink`	`array<array-key, mixed>\|yii2\extensions\bootstrap6\item\BreadcrumbLink\|false`	First item of the trail, `[]` for a link to `Application::$homeUrl` labeled `Home`, or `false` to omit it. See `$links` for the format. Default: `[]`.	`Breadcrumbs`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$itemTemplate`	`string`	Template of the inactive items; `{link}` is replaced by the rendered link. Default: `"<li class=\"breadcrumb-item\">{link}</li>\n"`.	`Breadcrumbs`
`$links`	`array<array-key, array<array-key, mixed>\|yii2\extensions\bootstrap6\item\BreadcrumbLink\|string\|Stringable>`	Items of the trail; the widget renders nothing when empty. Default: `[]`.	`Breadcrumbs`
`$navOptions`	`array<string, mixed>`	HTML attributes of the `<nav>` container tag. Default: `['aria-label' => 'breadcrumb']`.	`Breadcrumbs`
`$options`	`array<string, mixed>`	HTML attributes of the widget container tag. Default: `[]`.	`Widget`
`$tag`	`string`	Tag name of the list element. Default: `'ol'`.	`Breadcrumbs`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__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`
`__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`
`addAttributes()`	Adds a set of HTML attributes; attributes already set with the same name are replaced.	`AttributesTrait`
`addClass()`	Adds one or more CSS classes to the existing classes; duplicated classes are collapsed.	`AttributesTrait`
`addCssStyle()`	Adds CSS style properties to the `style` attribute.	`AttributesTrait`
`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`
`attribute()`	Sets an HTML attribute value.	`AttributesTrait`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	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`
`class()`	Replaces the existing CSS classes with the specified ones.	`AttributesTrait`
`className()` static	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()` static	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()`	Returns the view object that can be used to render views or view files.	`yii\base\Widget`
`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 object.	`yii\base\Widget`
`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()`		`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()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`pluginInitialization()` protected	Returns the JavaScript that initializes a plugin with its normalized constructor options.	`BootstrapWidgetTrait`
`registerClientEvents()` protected	Registers the JavaScript event handlers listed in `$clientEvents` at `View::POS_END`.	`BootstrapWidgetTrait`
`registerPlugin()` protected	Registers the plugin asset, the plugin initialization when needed, and the `$clientEvents`.	`BootstrapWidgetTrait`
`renderItem()` protected	Renders an item of the trail.	`Breadcrumbs`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Property details

$links

public array<array-key, array<array-key, mixed>|yii2\extensions\bootstrap6\item\BreadcrumbLink|string|Stringable> $links = []

Items of the trail; the widget renders nothing when empty.

Each item is a BreadcrumbLink, a label string (active item), a url => label pair, or an array converted through BreadcrumbLink::fromArray() with the keys label (required, string or Stringable), url, active, encode, template, and any other key rendered as an attribute of the link tag.

Method details

run()

public function run(): string

Returns

string

Throws

yii\base\InvalidConfigException: if an item has no label.

renderItem()

protected function renderItem(yii2\extensions\bootstrap6\item\BreadcrumbLink $link): string

Renders an item of the trail.

Parameters

Parameter	Type	Description
`$link`	`yii2\extensions\bootstrap6\item\BreadcrumbLink`

Returns

string: Generated HTML.