yiisoft/yii2-bootstrap5 API Documentation 2.0

This is the API Documentation for the yiisoft/yii2-bootstrap5 extension. Here you will find detailed information about all classes provided by this extension. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 2.0 of the extension. You can use the dropdown menu on the top right to switch between versions.

Class	Description
yii\bootstrap5\Accordion	Accordion renders an accordion bootstrap javascript component.
yii\bootstrap5\ActiveField	A Bootstrap 5 enhanced version of \yii\widgets\ActiveField.
yii\bootstrap5\ActiveForm	A Bootstrap 5 enhanced version of \yii\widgets\ActiveForm.
yii\bootstrap5\Alert	Alert renders an alert bootstrap component.
yii\bootstrap5\BaseHtml	BaseHtml provides concrete implementation for yii\bootstrap5\Html.
yii\bootstrap5\BootstrapAsset	Twitter Bootstrap 5 CSS bundle.
yii\bootstrap5\BootstrapIconAsset	Twitter Bootstrap 5 icon bundle
yii\bootstrap5\BootstrapPluginAsset	Twitter Bootstrap 5 JavaScript bundle.
yii\bootstrap5\BootstrapWidgetTrait	BootstrapWidgetTrait is the trait, which provides basic for all Bootstrap widgets features.
yii\bootstrap5\Breadcrumbs	This widget represents a Bootstrap 5 component "Breadcrumb". It displays a list of links indicating the position of the current page in the whole site hierarchy.
yii\bootstrap5\Button	Button renders a bootstrap button.
yii\bootstrap5\ButtonDropdown	ButtonDropdown renders a group or split button dropdown bootstrap component.
yii\bootstrap5\ButtonGroup	ButtonGroup renders a button group bootstrap component.
yii\bootstrap5\ButtonToolbar	ButtonToolbar Combines sets of button groups into button toolbars for more complex components.
yii\bootstrap5\Carousel	Carousel renders a carousel bootstrap javascript component.
yii\bootstrap5\Dropdown	Dropdown renders a Bootstrap dropdown menu component.
yii\bootstrap5\Html
yii\bootstrap5\InputWidget
yii\bootstrap5\LinkPager	LinkPager represents a Bootstrap 5 version of \yii\widgets\LinkPager. It displays a list of hyperlinks that lead to different pages of target.
yii\bootstrap5\Modal	Modal renders a modal window that can be toggled by clicking on a button.
yii\bootstrap5\Nav	Nav renders a nav HTML component.
yii\bootstrap5\NavBar	NavBar renders a navbar HTML component.
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.
yii\bootstrap5\Popover	Popover renders a popover that can be toggled by clicking on a button.
yii\bootstrap5\Progress	Progress renders a bootstrap progress bar component.
yii\bootstrap5\Tabs	Tabs renders a Tab bootstrap javascript component.
yii\bootstrap5\Toast	Toasts renders an toast bootstrap component.
yii\bootstrap5\ToggleButtonGroup	ToggleButtonGroup allows rendering form inputs Checkbox/Radio toggle button groups.
yii\bootstrap5\Widget	\yii\bootstrap5\Widget is the base class for all bootstrap5 widgets.
yii\bootstrap5\i18n\TranslationBootstrap	This bootstrap implementation is used to add translations automatically to application configuration.