Class yii\bootstrap5\Offcanvas
Offcanvas is a sidebar component that can be toggled via JavaScript to appear from the left, right, or bottom edge of the viewport. Buttons or anchors are used as triggers that are attached to specific elements you toggle, and data attributes are used to invoke the required JavaScript.
The following example will show the content enclosed the begin() and end() calls within the offcancas container:
Offcanvas::begin([
'placement' => Offcanvas::PLACEMENT_END,
'backdrop' => true,
'scrolling' => true
]);
Nav::widget([...]);
Offcanvas::end();
See also https://getbootstrap.com/docs/5.1/components/offcanvas/.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $backdrop | boolean | Whether to enable backdrop or not. | yii\bootstrap5\Offcanvas |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
| $bodyOptions | array | Additional body options. | yii\bootstrap5\Offcanvas |
| $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\Offcanvas |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $headerOptions | array | Additional header options. | yii\bootstrap5\Offcanvas |
| $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 |
| $placement | string | Where to place the offcanvas. | yii\bootstrap5\Offcanvas |
| $scrolling | boolean | Whether to enable body scrolling or not. | yii\bootstrap5\Offcanvas |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $title | string | The title content in the offcanvas container. | yii\bootstrap5\Offcanvas |
| $titleOptions | array | Additional title options. | yii\bootstrap5\Offcanvas |
| $toggleButton | array|false | The options for rendering the toggle button tag. | yii\bootstrap5\Offcanvas |
| $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() | {@inheritDoc} | yii\bootstrap5\Offcanvas |
| 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\bootstrap5\Offcanvas |
| 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\Offcanvas |
| 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 modal body. | yii\bootstrap5\Offcanvas |
| renderBodyEnd() | Renders the closing tag of the modal body. | yii\bootstrap5\Offcanvas |
| renderCloseButton() | Renders the close button. | yii\bootstrap5\Offcanvas |
| renderHeader() | Renders the header HTML markup of the modal | yii\bootstrap5\Offcanvas |
| renderToggleButton() | Renders the toggle button. | yii\bootstrap5\Offcanvas |
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 |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| PLACEMENT_BOTTOM | 'bottom' | yii\bootstrap5\Offcanvas | |
| PLACEMENT_END | 'end' | yii\bootstrap5\Offcanvas | |
| PLACEMENT_START | 'start' | yii\bootstrap5\Offcanvas | |
| PLACEMENT_TOP | 'top' | yii\bootstrap5\Offcanvas |
Property Details
Whether to enable backdrop or not. Defaults to true.
Additional 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 offcanvas container. Clicking on the button will hide the offcanvas container. If this is false, no close button will be rendered.
The following special options are supported:
- tag: string, the tag name of the button. Defaults to 'button'.
The rest of the options will be rendered as the HTML attributes of the button tag. Please refer to the Offcanvas plugin help for the supported HTML attributes.
Additional header options.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
Where to place the offcanvas. Can be of of the [[PLACEMENT_*]] constants.
Whether to enable body scrolling or not. Defaults to false.
The title content in the offcanvas container.
Additional title options.
The following special options are supported:
- tag: string, the tag name of the button. Defaults to 'h5'.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
The options for rendering the toggle button tag. The toggle button is used to toggle the visibility of the modal window. If this property is false, no toggle button will be rendered.
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 'Show'.
The rest of the options will be rendered as the HTML attributes of the button tag. Please refer to the Modal plugin help for the supported HTML attributes.
Method Details
{@inheritDoc}
| public void init ( ) |
Initializes the widget options.
This method sets the default values for various options.
| protected void initOptions ( ) |
Renders the opening tag of the modal body.
| protected string renderBodyBegin ( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the closing tag of the modal body.
| 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 |
|---|---|---|
Renders the toggle button.
| protected string|null renderToggleButton ( ) | ||
| return | string|null | The rendering result |
|---|---|---|
Renders the widget.
| public void run ( ) |