Toast

API reference › Bootstrap 6 › Toast

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

Renders a Bootstrap toast with an optional header and initializes its plugin.

Content captured between begin() and end() is rendered inside the .toast-body element, before $body. The toast stays hidden until show() is called on its plugin instance, or until the show class is added through $options.

Properties

Property	Type	Description	Defined by
`$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`
`$body`	`string\|Stringable\|null`	Content appended to the `.toast-body` element (not encoded), or `null`. Default: `null`.	`Toast`
`$bodyOptions`	`array<string, mixed>`	HTML attributes of the `.toast-body` element. Default: `[]`.	`Toast`
`$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`
`$closeButton`	`array<string, mixed>\|false`	HTML attributes of the close button, see `Html::closeButton()`, or `false` to omit the button. Default: `[]`.	`Toast`
`$dateTime`	`DateTimeInterface\|int\|string\|null`	Time rendered in the header as a relative time (for example, `2 hours ago`), or `null` to omit it. Default: `null`.	`Toast`
`$dateTimeOptions`	`array<string, mixed>`	HTML attributes of the time element; the `tag` option sets the tag name (default `small`). Default: `[]`.	`Toast`
`$encodeTitle`	`bool`	Whether to HTML-encode `$title`. Default: `true`.	`Toast`
`$headerOptions`	`array<string, mixed>`	HTML attributes of the `.toast-header` element. Default: `[]`.	`Toast`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$instant`	`bool`	Whether to disable the fade animation (`.toast-instant`). Default: `false`.	`Toast`
`$options`	`array<string, mixed>`	HTML attributes of the widget container tag. Default: `[]`.	`Widget`
`$title`	`string\|Stringable\|null`	Content of the header title, or `null` to omit it. Default: `null`.	`Toast`
`$titleOptions`	`array<string, mixed>`	HTML attributes of the header title; the `tag` option sets the tag name (default `strong`). Default: `[]`.	`Toast`
`$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()`		`Toast`
`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()`		`Toast`
`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`
`renderHeader()` protected	Renders the `.toast-header` element, or an empty string when there is no title, time, or close button.	`Toast`
`toastOptions()` protected	Returns the HTML attributes of the `.toast` element.	`Toast`

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`

Method details

init()

public function init(): void

run()

public function run(): string

Returns

string

renderHeader()

protected function renderHeader(): string

Renders the .toast-header element, or an empty string when there is no title, time, or close button.

Returns

string

toastOptions()

protected function toastOptions(): mixed[]

Returns the HTML attributes of the .toast element.

The role, aria-live, and aria-atomic attributes default to alert, assertive, and true; values given in $options, either flat (aria-live) or nested (aria => ['live' => ...]), are kept.

Returns

mixed[]