README

Yii2 extension for CoreUI admin dashboard

Installation

The preferred way to install this extension is through composer.

php composer.phar require --prefer-dist andres-breads/yii2-coreui "*"

or add

"andres-breads/yii2-coreui": "*"

to the require section of your composer.json file.

Usage

Make your module or controller layout to be @andresbreads/coreui/layouts/main.php by modifiying the layout attribute.

Also you can make your @app/views/layouts/main.php to look like:

<?php $this->beginContent('@andresbreads/coreui/layouts/main.php') ?>
    <?= $content ?>
<?php $this->endContent() ?>

If you want to customize the menus, footer and user thumbnail, these are the params used inside the layout to overwrite them:

$this->params['mainMenu']; // Receives a list to be used in Menu::widget()
$this->params['topLeftMenu']; // Receives a list to be used in Nav::widget()
$this->params['topRightMenu']; // Receives a list to be used in Nav::widget()
$this->params['userThumbnail']; // Receives a string to be used in <img src>
$this->params['userMenu']; // Receives a list to be used in Dropdown::widget()
$this->params['leftFooter']; // Receives a string
$this->params['rightFooter']; // Receives a string