AdminLTE Asset Bundle
Backend UI for Yii2 Framework, based on AdminLTE, (*1)
, (*2)
This package contains an Asset Bundle for Yii 2.0 Framework
which registers the CSS files for the AdminLTE user-interface., (*3)
The CSS files are installed via Yii's recommended usage of the fxp/composer-asset-plugin
v1.1.1 or later., (*4)
Installation
The preferred way to install this extension is through composer., (*5)
To install AdminLTE v2 run:, (*6)
php composer.phar require gudezi/yii2-adminlte-asset "*"
Quick Start
Once the extension is installed, you can have a preview by reconfiguring the path mappings of the view component:, (*7)
For Yii 2 Application Template or Basic Application Template, (*8)
'components' => [
'view' => [
'theme' => [
'pathMap' => [
'@app/views' => '@vendor/gudezi/yii2-adminlte-asset/example-views/yiisoft/yii2-app'
],
],
],
],
For Phundament 4, (*9)
'components' => [
'view' => [
'theme' => [
'pathMap' => [
'@app/views' => '@vendor/gudezi/yii2-adminlte-asset/example-views/phundament/app'
],
],
],
],
This asset bundle provides sample files for layout and view (see folder examples/
), they are not meant to be customized directly in the vendor/
folder., (*10)
Therefore it is recommended to copy the views into your application and adjust them to your needs., (*11)
Customization
- Copy files from
vendor/gudezi/yii2-adminlte-asset/example-views/yiisoft/yii2-app
(or other theme) to @app/views
.
- Remove the custom
view
configuration from your application by deleting the path mappings, if you have made them before.
- Edit your views adhering to html markup
vendor/gudezi/adminlte/pages
Skins
By default the extension uses blue skin for AdminLTE. You can change it in config file., (*12)
'components' => [
'assetManager' => [
'bundles' => [
'gudezi\web\AdminLteAsset' => [
'skin' => 'skin-black',
],
],
],
],
And then just replace class of body skin-blue
. You can use AdminLteHelper::skinClass()
if you don't want to alter every view file when you change skin color., (*13)
<body class="<?= \gudezi\helpers\AdminLteHelper::skinClass() ?>">
Note: Use AdminLteHelper::skinClass()
only if you override the skin through configuration. Otherwise you will not get the correct css class of body., (*14)
Here is the list of available skins:, (*15)
"skin-blue",
"skin-black",
"skin-red",
"skin-yellow",
"skin-purple",
"skin-green",
"skin-blue-light",
"skin-black-light",
"skin-red-light",
"skin-yellow-light",
"skin-purple-light",
"skin-green-light"
If you want to use native DOM of headers AdminLTE, (*16)
<h1>
About <small>static page</small>
</h1>
then you can follow the code:, (*17)
/* @var $this yii\web\View */
$this->params['breadcrumbs'][] = 'About';
$this->beginBlock('content-header'); ?>
About <small>static page</small>
endBlock(); ?>
This is the About page. You may modify the following file to customize its content: , (*18)
= __FILE__ ?>
If you need to separate sections of the menu then just add the li.header
item to items
, (*19)
'items' => [
['label' => 'Gii', 'icon' => 'fa fa-file-code-o', 'url' => ['/gii']],
['label' => 'Debug', 'icon' => 'fa fa-dashboard', 'url' => ['/debug']],
['label' => 'MAIN NAVIGATION', 'options' => ['class' => 'header']], // here
// ... a group items
['label' => '', 'options' => ['class' => 'header']],
// ... a group items
['label' => '', 'options' => ['class' => 'header']],
// ... a group items
To add a label for a item:, (*20)
'items' => [
[
'label' => '<span>Mailbox</span><span class="pull-right-container"><small class="label pull-right bg-yellow">' . $mailCount . '</small></span>',
'icon' => 'fa fa fa-envelope-o',
'url' => ['/mailbox'],
'encode' => false,
],
For AdminLTE documentation, please read https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html, (*21)
Namespacing rules follow the Yii 2.0 framework structure, eg. gudezi\web
for the Asset Bundle., (*22)