yiisoft/yii-bootstrap5

Yii Framework Twitter Bootstrap 5 Extension

dev-master / 3.0.x-dev 2024-03-08 01:01 UTC

Requires

• php: ^8.1
• yiisoft/arrays: ^1.0|^2.0|^3.0
• yiisoft/assets: ^4.0
• yiisoft/files: ^2.0
• yiisoft/html: ^3.0
• yiisoft/json: ^1.0
• yiisoft/widget: ^2.0

Requires (Dev)

• maglnet/composer-require-checker: ^4.3
• phpunit/phpunit: ^9.6
• rector/rector: ^1.0
• roave/infection-static-analysis-plugin: ^1.16
• spatie/phpunit-watcher: ^1.23
• vimeo/psalm: ^5.21
• yiisoft/aliases: ^3.0
• yiisoft/di: ^1.0

Provides

• yiisoft/yii-bootstrap: 1.0

BSD-3-Clause

• yii
• bootstrap5

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.

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.

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

Install assets

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

1. 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

1. 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') ?>

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework. To run it:

./vendor/bin/infection

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Support the project

Follow updates

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.