yii2-bootswatch4-asset ¶

1. Installation
2. Usage
3. About Versioning
4. License

Asset bunlde around the Bootswatch Theme Suite based on bootstrap 4.

If you are using Bootstrap 3, please refer to the dedicated extension yii2-bootswatch-asset.

Installation ¶

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist raoul2000/yii2-bootswatch4-asset "*"

or add

"raoul2000/yii2-bootswatch4-asset": "*"

to the require section of your composer.json file.

Usage ¶

Note that this asset bundle does NOT include Bootstrap 4 files, but only the Bootswatch CSS files dedicated to overload Bootstrap default theme. To use the Bootstrap 4 files with your Yii2 application, check the yii2-bootstrap4 extension.

To use a bootswatch theme in your Yii2 application add the BootswatchAsset bundle to your main AppAsset bundle:

// ./assets/AppAsset.php

class AppAsset extends AssetBundle
{
    public $basePath = '@webroot';
    public $baseUrl = '@web';
    public $css = [
        'css/site.css',
    ];
    public $js = [
    ];
    public $depends = [
        'yii\web\YiiAsset',
    	'raoul2000\bootswatch4\BootswatchAsset',
    ];
}
?>

Then at some point you must select the theme name you want to use. In the example below, the theme materia is set in the main layout file.

// ./views/layouts/main.php

raoul2000\bootswatch4\BootswatchAsset::$theme = 'materia';
AppAsset::register($this);

About Versioning ¶

By convention this extension is using the same version number as the project thomaspark/bootswatch it depends on. Consequently, the first version of this extension is 4.3.1.

License ¶

yii2-bootswatch4-asset is released under the BSD 3-Clause License. See the bundled LICENSE.md for details.