README

Yii Framework Twitter Bootstrap 5 Extension

This Yii Framework extension encapsulates Twitter Bootstrap 5 components and plugins in terms of Yii widgets, and thus makes using Bootstrap components/plugins in Yii applications extremely easy.

Requirements

PHP 8.1 or higher.

Installation

The package could be installed with Composer:

composer require yiisoft/yii-bootstrap5

Install assets

There are several ways to install the assets, they are:

Using the AssetPackagist package manager.

Add to composer.json the following:

{
    "require": {
        "npm-asset/bootstrap": "^5.3",
        "oomphinc/composer-installers-extender": "^2.0"
    },
    "extra": {
        "installer-types": [
            "npm-asset"
        ],
        "installer-paths": {
            "./node_modules/{$name}": [
                "type:npm-asset"
            ]
        }
    },
    "repositories": [
        {
            "type": "composer",
            "url": "https://asset-packagist.org"
        }
    ]
}

Once the changes are made, you can install the assets using the following command:

composer update

Using the npm-asset package manager.

Run the following command at the root directory of your application.

npm i bootstrap@5.3.1

General usage

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

<?= Yiisoft\Yii\Bootstrap5\Progress::widget()
    ->percent('60')
    ->label('test') ?>

Documentation

Twitter Bootstrap 5.3
Guide: English, 中国人, 日本語, Português - Brasil, Español, Русский, українська
Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Framework Twitter Bootstrap 5 Extension is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

rossaddison / yii-bootstrap5

Maintainers

Details