Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yidas/yii2-bootstrap
Bootstrap Asset Bundle for Yii2 framework with official Composer
https://github.com/yidas/yii2-bootstrap
asset-bundle bootstrap bootstrap4 yii2 yii2-asset yii2-extension
Last synced: 2 months ago
JSON representation
Bootstrap Asset Bundle for Yii2 framework with official Composer
- Host: GitHub
- URL: https://github.com/yidas/yii2-bootstrap
- Owner: yidas
- License: mit
- Created: 2018-09-05T16:09:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-30T14:35:43.000Z (about 6 years ago)
- Last Synced: 2024-10-01T14:25:15.426Z (3 months ago)
- Topics: asset-bundle, bootstrap, bootstrap4, yii2, yii2-asset, yii2-extension
- Language: PHP
- Homepage: https://getbootstrap.com/
- Size: 8.79 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Bootstrap Extension for Yii 2
Bootstrap Asset Bundle extension for Yii2 framework with official Composer
[](https://packagist.org/packages/yidas/yii2-bootstrap)
[](https://packagist.org/packages/yidas/yii2-bootstrap)
[](https://packagist.org/packages/yidas/yii2-bootstrap)
This is the [Bootstrap](https://getbootstrap.com/) extension for [Yii framework 2.0](http://www.yiiframework.com/). It encapsulates [Bootstrap](https://github.com/twbs/bootstrap) distribution assets and thus makes using Bootstrap in Yii applications extremely easy.
FEATURES
--------
- ***No Bower**, Composer installation only*
- ***CDN & Official** assets source provided*
- ***Version Controll** refers to jQuery*
---
REQUIREMENTS
------------
This library requires the following:
- PHP 5.4.0+
- yiisoft/yii2 2.0.6+
- twbs/bootstrap 4.0+
- yidas/yii2-jquery 2.0+
---
INSTALLATION
------------
The preferred install way is through [Composer](http://getcomposer.org/download/):
```
composer require yidas/yii2-bootstrap
```
Version options refered Bootstrap release:
```
composer require yidas/yii2-bootstrap ~3.0
composer require yidas/yii2-bootstrap ~4.0
```
Or you could edit `composer.json` with adding package in require section then run `composer update`.
```
"yidas/yii2-bootstrap": "*"
```
---
CONFIGURATION
-------------
Register or depend Asset into your application:
```php
yidas\yii\bootstrap\BootstrapAsset
```
For example, to register Bootstrap assets in view :
```php
\yidas\yii\bootstrap\BootstrapAsset::register($this);
```
Or as dependency in your app asset bundle :
```php
namespace app\assets;
use yii\web\AssetBundle;
class AppAsset extends AssetBundle
{
public $basePath = '@webroot';
public $baseUrl = '@web';
public $css = [
'css/site.css',
];
public $js = [
];
public $depends = [
'yii\web\YiiAsset',
'yidas\yii\bootstrap\BootstrapAsset'
];
}
```
### CDN Asset Mode
You could switch Asset to use CDN distribution by configuring `config` file:
```php
'components' => [
'assetManager' => [
'bundles' => [
'yidas\yii\bootstrap\BootstrapAsset' => [
'cdn' => true,
// 'cdnVersion' => '4.1.3',
],
],
],
],
```
#### Specify a CDN source
You could also specify CDN source you like:
```php
'assetManager' => [
'bundles' => [
'yidas\yii\fontawesome\FontawesomeAsset' => [
'cdn' => true,
'cdnCSS' => ['https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css'],
'cdnJS' => ['https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js'],
],
],
],
```
### jQuery Dependency
This Bootstrap extension required [jQuery](https://github.com/jquery/jquery) Javascript library, you could set `yii\web\JqueryAsset` in `$depends`, or simplly depends a asset included your own jQuery JS file whether is CDN or not.
```php
public $depends = [
//'yii\web\JqueryAsset',
'yidas\yii\jquery\JqueryAsset',
'yidas\yii\bootstrap\BootstrapAsset'
];
```
Another way, you could easliy enable jquery dependency by setting `jquery` property form `BootstrapAsset`:
```php
'components' => [
'assetManager' => [
'bundles' => [
'yidas\yii\bootstrap\BootstrapAsset' => [
'jquery' => true,
// 'cdn' => true,
],
'yidas\yii\jquery\JqueryAsset' => [
// 'cdn' => true,
],
],
],
],
```
---
USAGE
-----
### Version Control
#### Update dependent packages
composer update yidas/yii2-bootstrap
#### Update newest Bootstrap version
composer update twbs/bootstrap
#### Specify a Bootstrap version
composer require twbs/bootstrap 4.1.3