Override/Eliminate Bootstrap CSS/JS for Yii 2.0 widgets

You are viewing revision #6 of this wiki article.
This is the latest version of this article.
You may want to see the changes made in this revision.

« previous (#5)

Bootstrap Extension Widgets

  1. Option 1: Updating object DI config
  2. Option 2: Extend Yii Class

In Yii 2.0, the yii widgets that use Twitter Bootstrap CSS & JS directly, are part of the yii2-bootstrap extension, starting with yii/bootstrap namespace. For customizing bootstrap extension specific widget assets, you could configure your own assets (CSS/JS) using the new Yii Asset Manager in your Yii Config file. Something like:

'components' => [
    'assetManager' => [
        'bundles' => [
            'yii\bootstrap\BootstrapAsset' => [
                 'sourcePath' => 'your-path',
                 'css' => ['css/bootstrap.css', 'path/to/custom.css']
            ],
        ],
    ],
],

Customizing Other Widgets

For other Yii widgets that are not part of an inbuilt Yii extension (like bootstrap or JUI), the widget itself does not have any CSS inbuilt. Rather the widget uses Bootstrap HTML markup as default which you can override.

An example of customizing the Yii GridView is mentioned here. You can easily override Bootstrap or other styling defaults by changing the GridView default options.

Option 1: Updating object DI config

The simpler direct approach for you would be to override defaults for Yii's class configuration. You may use \Yii::$container->set to set up the needed dependencies of classes and their initial property values. For global use - you can set this in your webroot index.php or the config file.

// Set GridView defaults
\Yii::$container->set('yii\grid\GridView', [
    'tableOptions' => [
        'class' => 'table table-striped table-bordered',
    ],
]);
// Set LinkPager defaults
\Yii::$container->set('yii\widgets\LinkPager', [
    'options' => [
        'class' => 'pagination',
    ],
]);

Option 2: Extend Yii Class

You can alternatively create custom classes extending Yii's inbuilt ones so you can use them across your app. For example:

namespace frontend\widgets;
class MyGridView extends \yii\grid\GridView 
{
    // change the following line
    public $tableOptions = ['class' => 'table table-striped table-bordered'];

    // override styling of your data columns
    public $dataColumnClass = 'frontend\widgets\MyDataColumn';

    // override styling of your pager
    public $pager = [
        'options' => ['class' => 'pagination'],
        'firstPageCssClass' => 'first',
        'lastPageCssClass' => 'last',
        'prevPageCssClass' => 'prev',
        'nextPageCssClass' => 'next',
        'activePageCssClass' => 'active',
        'disabledPageCssClass' => 'disabled'
    ];

    // override styling of your sorter
    public $sorter = ['options' => ['class' => 'sorter']];

    // override other styles through these options
    public $options = ['class' => 'grid-view'];
    public $headerRowOptions = [];
    public $footerRowOptions = [];
    public $rowOptions = [];
}

Your extended DataColumn can look like:

namespace frontend\widgets;
class MyDataColumn extends \yii\grid\DataColumn
{
    // customize by changing your styles
    public $filterInputOptions = ['class' => 'form-control', 'id' => null];
    // customize by changing your styles
    public $sortLinkOptions = [];
}
4 2
39 followers
Viewed: 57 048 times
Version: 2.0
Category: How-tos
Written by: Kartik V
Last updated by: CeBe
Created on: Feb 27, 2014
Last updated: 6 years ago
Update Article

Revisions

View all history

Related Articles