Class yii\bootstrap5\Toast
Toasts renders an toast bootstrap component.
For example,
echo Toast::widget([
'title' => 'Hello world!',
'dateTime' => 'now',
'body' => 'Say hello...',
]);
The following example will show the content enclosed between the begin() and end() calls within the toast box:
Toast::begin([
'title' => 'Hello world!',
'dateTime' => 'now'
]);
echo 'Say hello...';
Toast::end();
See also https://getbootstrap.com/docs/5.1/components/toasts/.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $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 |
| $body | string|null | The body content in the alert component. | yii\bootstrap5\Toast |
| $bodyOptions | array | Body options | yii\bootstrap5\Toast |
| $clientEvents | array | The event handlers for the underlying Bootstrap JS plugin. | yii\bootstrap5\BootstrapWidgetTrait |
| $clientOptions | array|boolean | The options for the underlying Bootstrap JS plugin. | yii\bootstrap5\BootstrapWidgetTrait |
| $closeButton | array|false | The options for rendering the close button tag. | yii\bootstrap5\Toast |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $dateTime | integer|string|DateTime|DateTimeInterface|DateInterval|false | The date time the toast message references to. | yii\bootstrap5\Toast |
| $dateTimeOptions | array | Additional date time part options The following special options are supported: - tag: string, the tag name of the button. | yii\bootstrap5\Toast |
| $headerOptions | array | Additional header options | yii\bootstrap5\Toast |
| $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 |
| $options | array | The HTML attributes for the widget container tag. | yii\bootstrap5\Widget |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $title | string|null | The title content in the toast. | yii\bootstrap5\Toast |
| $titleOptions | array | Additional title options The following special options are supported: - tag: string, the tag name of the button. | yii\bootstrap5\Toast |
| $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() | 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 widget. | yii\bootstrap5\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() | Executes the widget. | yii\bootstrap5\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() | Creates a widget instance and runs it. | yii\base\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| initOptions() | Initializes the widget options. | yii\bootstrap5\Toast |
| registerClientEvents() | Registers JS event handlers that are listed in $clientEvents. | yii\bootstrap5\BootstrapWidgetTrait |
| registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap5\BootstrapWidgetTrait |
| renderBodyBegin() | Renders the opening tag of the toast body. | yii\bootstrap5\Toast |
| renderBodyEnd() | Renders the toast body and the close button (if any). | yii\bootstrap5\Toast |
| renderCloseButton() | Renders the close button. | yii\bootstrap5\Toast |
| renderHeader() | Renders the header HTML markup of the modal | yii\bootstrap5\Toast |
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 body content in the alert component. Note that anything between the begin() and end() calls of the Toast widget will also be treated as the body content, and will be rendered before this.
Body options
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The options for rendering the close button tag. The close button is displayed in the header of the toast. Clicking on the button will hide the toast.
The following special options are supported:
- tag: string, the tag name of the button. Defaults to 'button'.
- label: string, the label of the button. Defaults to '×'.
The rest of the options will be rendered as the HTML attributes of the button tag. Please refer to the Toast documentation for the supported HTML attributes.
The date time the toast message references to.
This will be formatted as relative time (via formatter component). It will be omitted if
set to false (default).
Additional date time part options
The following special options are supported:
- tag: string, the tag name of the button. Defaults to 'small'.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
Additional header options
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The title content in the toast.
Additional title options
The following special options are supported:
- tag: string, the tag name of the button. Defaults to 'strong'.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
Method Details
Initializes the widget.
This method will register the bootstrap asset bundle. If you override this method, make sure you call the parent implementation first.
| public void init ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
Initializes the widget options.
This method sets the default values for various options.
| protected void initOptions ( ) |
Renders the opening tag of the toast body.
| protected string renderBodyBegin ( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the toast body and the close button (if any).
| protected string renderBodyEnd ( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the close button.
| protected string|null renderCloseButton ( ) | ||
| return | string|null | The rendering result |
|---|---|---|
Renders the header HTML markup of the modal
| protected string renderHeader ( ) | ||
| return | string | The rendering result |
|---|---|---|
Executes the widget.
| public string|void run ( ) | ||
| return | string|void | The rendering result may be directly "echoed" or returned as a string |
|---|---|---|