2021-07-09 17:53:24 +08:00
< p align = "center" >
< a href = "http://getbootstrap.com/" target = "_blank" rel = "external" >
< img src = "https://getbootstrap.com/docs/5.0/assets/brand/bootstrap-logo.svg" height = "80px" >
< / a >
< h1 align = "center" > Twitter Bootstrap 5 Extension for Yii 2< / h1 >
< br >
< / p >
This is the Twitter Bootstrap extension for [Yii framework 2.0 ](http://www.yiiframework.com ). It encapsulates [Bootstrap 5 ](http://getbootstrap.com/ ) 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 ](LICENSE.md )-file.
Documentation is at [docs/guide/README.md ](docs/guide/README.md ).
2021-08-02 17:00:24 +08:00
[![Latest Stable Version ](https://poser.pugx.org/yiisoft/yii2-bootstrap5/v/stable.png )](https://packagist.org/packages/yiisoft/yii2-bootstrap5)
[![Total Downloads ](https://poser.pugx.org/yiisoft/yii2-bootstrap5/downloads.png )](https://packagist.org/packages/yiisoft/yii2-bootstrap5)
[![Build Status ](https://github.com/yiisoft/yii2-bootstrap5/workflows/build/badge.svg )](https://github.com/yiisoft/yii2-bootstrap5/actions)
2021-07-09 17:53:24 +08:00
Installation
------------
The preferred way to install this extension is through [composer ](http://getcomposer.org/download/ ).
Either run
```
2021-08-02 17:00:24 +08:00
php composer.phar require --prefer-dist yiisoft/yii2-bootstrap5
2021-07-09 17:53:24 +08:00
```
or add
```
2022-01-05 18:17:55 +08:00
"yiisoft/yii2-bootstrap5": "*"
2021-07-09 17:53:24 +08:00
```
to the require section of your `composer.json` file.
2022-01-05 18:17:55 +08:00
Translations
----
To use translations, configure your app like following
```php
'components' => [
// ...
'i18n' => [
'translations' => [
'yii/bootstrap5*' => [
'class' => 'yii\i18n\GettextMessageSource',
'sourceLanguage' => 'en-US',
'basePath' => '@yii/bootstrap5/messages',
],
],
],
],
```
2021-07-09 17:53:24 +08:00
Usage
----
For example, the following
single line of code in a view file would render a Bootstrap Progress plugin:
```php
<?= yii \bootstrap5 \Progress::widget(['percent' => 60, 'label' => 'test']) ?>
```