Drawer

API reference › Bootstrap 6 › Drawer

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

Renders a Bootstrap drawer on the native <dialog> element, optionally preceded by a toggle button.

Content captured between begin() and end() is rendered inside the .drawer-body element.

Properties

Property	Type	Description	Defined by
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$backdrop`	`bool\|string`	Backdrop behavior: `true` closes the drawer on backdrop click, `false` hides the backdrop, and `static` keeps the drawer open on backdrop click. Default: `true`.	`Drawer`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$bodyOptions`	`array<string, mixed>`	HTML attributes of the `.drawer-body` element. Default: `[]`.	`Drawer`
`$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: `[]`.	`Drawer`
`$encodeTitle`	`bool`	Whether to HTML-encode `$title`. Default: `true`.	`Drawer`
`$footer`	`string\|Stringable\|null`	Content of the `.drawer-footer` element (not encoded), or `null` to omit the footer. Default: `null`.	`Drawer`
`$footerOptions`	`array<string, mixed>`	HTML attributes of the `.drawer-footer` element. Default: `[]`.	`Drawer`
`$fullscreen`	`bool`	Whether the drawer covers the entire viewport (`.drawer-fullscreen`); replaces the `$placement` class. Default: `false`.	`Drawer`
`$headerOptions`	`array<string, mixed>`	HTML attributes of the `.drawer-header` element. Default: `[]`.	`Drawer`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$keyboard`	`bool`	Whether the Escape key closes the drawer. Default: `true`.	`Drawer`
`$options`	`array<string, mixed>`	HTML attributes of the widget container tag. Default: `[]`.	`Widget`
`$placement`	`yii2\extensions\bootstrap6\enum\DrawerPlacement\|string\|null`	Placement class, for example `DrawerPlacement::END`, or `null` to omit it. Default: `\yii2\extensions\bootstrap6\enum\DrawerPlacement::START`.	`Drawer`
`$responsive`	`yii2\extensions\bootstrap6\enum\Breakpoint\|string\|null`	Breakpoint from which the content renders inline instead of in a drawer (`md` renders `md:drawer`), or `null`. Default: `null`.	`Drawer`
`$scroll`	`bool`	Whether the page body keeps scrolling while the drawer is open. Default: `false`.	`Drawer`
`$sheet`	`bool`	Whether the drawer renders flush against the viewport edge (`.drawer-sheet`). Default: `false`.	`Drawer`
`$title`	`string\|Stringable\|null`	Content of the `.drawer-title` element, or `null` to omit the title. Default: `null`.	`Drawer`
`$titleOptions`	`array<string, mixed>`	HTML attributes of the `.drawer-title` element; the `tag` option sets the tag name (default `h5`). Default: `[]`.	`Drawer`
`$toggleButton`	`array<string, mixed>\|false`	HTML attributes of the toggle button rendered before the drawer, or `false` to omit the button. Default: `false`.	`Drawer`
`$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`
`addTogglerAttribute()`	Sets an HTML attribute value of the toggler.	`TogglerAttributesTrait`
`addTogglerClass()`	Adds one or more CSS classes to the existing toggler classes; duplicated classes are collapsed.	`TogglerAttributesTrait`
`addTogglerCssStyle()`	Adds CSS style properties to the `style` attribute of the toggler.	`TogglerAttributesTrait`
`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 widget, validates its options, and starts capturing the content.	`Drawer`
`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()`		`Drawer`
`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`
`drawerOptions()` protected	Returns the HTML attributes of the `<dialog>` element.	`Drawer`
`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`
`renderFooter()` protected	Renders the `.drawer-footer` element prefixed with a line break, or an empty string without `$footer`.	`Drawer`
`renderHeader()` protected	Renders the `.drawer-header` element, or an empty string when there is neither a title nor a close button.	`Drawer`
`renderToggleButton()` protected	Renders the toggle button, or an empty string when `$toggleButton` is `false`.	`Drawer`
`togglerOptions()` protected	Returns `$toggleButton` by reference, replacing `false` with an empty array to enable the toggle button.	`Drawer`

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

$title

public string|Stringable|null $title = null

Content of the .drawer-title element, or null to omit the title.

The drawer references the title by aria-labelledby unless $options already sets aria-label or aria-labelledby, either flat (aria-label) or nested (aria => ['label' => ...]).

$toggleButton

public array<string, mixed>|false $toggleButton = false

HTML attributes of the toggle button rendered before the drawer, or false to omit the button.

The label option sets the content (default translated Show), encode controls its encoding (default true), and tag sets the tag name (default button).

Method details

init()

public function init(): void

Initializes the widget, validates its options, and starts capturing the content.

Throws

yii\base\InvalidConfigException: if $backdrop, $placement, or $responsive has an unsupported value.

run()

public function run(): string

Returns

string

drawerOptions()

protected function drawerOptions(): mixed[]

Returns the HTML attributes of the <dialog> element.

Returns

mixed[]

renderFooter()

protected function renderFooter(): string

Renders the .drawer-footer element prefixed with a line break, or an empty string without $footer.

Returns

string

renderHeader()

protected function renderHeader(): string

Renders the .drawer-header element, or an empty string when there is neither a title nor a close button.

Returns

string

renderToggleButton()

protected function renderToggleButton(): string

Renders the toggle button, or an empty string when $toggleButton is false.

Returns

string

togglerOptions()

protected function togglerOptions(): array<string, mixed>

Returns $toggleButton by reference, replacing false with an empty array to enable the toggle button.

Returns

array<string, mixed>