yii2-bootstrap5/README.md

Twitter Bootstrap 5 Extension for Yii 2

This is the Twitter Bootstrap extension for Yii framework 2.0. It encapsulates Bootstrap 5 components and plugins in terms of Yii widgets, and thus makes using Bootstrap components/plugins in Yii applications extremely easy.

For license information check the LICENSE-file.

Documentation is at docs/guide/README.md.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yiisoft/yii2-bootstrap5

or add

"yiisoft/yii2-bootstrap5": "*"

to the require section of your composer.json file.

Translations

To use translations, configure your app like following

'components' => [
    // ...
    'i18n' => [
        'translations' => [
            'yii/bootstrap5*' => [
                'class' => 'yii\i18n\GettextMessageSource',
                'sourceLanguage' => 'en-US',
                'basePath' => '@yii/bootstrap5/messages',
            ],
        ],
    ],
],

Usage

For example, the following single line of code in a view file would render a Bootstrap Progress plugin:

<?= yii\bootstrap5\Progress::widget(['percent' => 60, 'label' => 'test']) ?>