2017 © Pedro Peláez
 

yii2-extension yii2-adminlte-asset

AdminLTE backend theme asset bundle for Yii 2.0 Framework

image

gbksoft/yii2-adminlte-asset

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  • Thursday, January 25, 2018
  • by gbksoft
  • Repository
  • 2 Watchers
  • 0 Stars
  • 26 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 355 Forks
  • 0 Open issues
  • 40 Versions
  • 0 % Grown

The README.md

AdminLTE Asset Bundle

Latest Stable Version Total Downloads License, (*1)

Backend UI for Yii2 Framework, based on AdminLTE, (*2)

"Yii2 AdminLTE Presentation", (*3)

This package contains an Asset Bundle for Yii 2.0 Framework which registers the CSS files for the AdminLTE user-interface., (*4)

The CSS files are installed via Yii's recommended usage of the fxp/composer-asset-plugin v1.1.1 or later., (*5)

Installation

The preferred way to install this extension is through composer., (*6)

To install AdminLTE v2 run:, (*7)

composer require dmstr/yii2-adminlte-asset "^2.1"

To install AdminLTE v1 run:, (*8)

composer require dmstr/yii2-adminlte-asset "^1"

FAQ

Web-font usage

AdminLTE dropped web-font inclusion in 2.4.0, so you need to include your desired font manually, ie., (*9)

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,300italic,400italic,600italic">

Inclusion via CDN is not recommended for production, please adjust this to your project's asset-bundling workflow., (*10)

For details see #140., (*11)

Upgrading

When upgrading please see the AdminLTE upgrade guide for adjustments you need to make in your views., (*12)

Composer installation

  • For issues with DmitryBaranovskiy/eve.git, please see #113.

Compatibility matrix

yii2-adminlte-asset AdminLTE
2.4 2.0 - 2.3
2.5 2.4

For other issues, please search GitHub first., (*13)

Quick Start

Once the extension is installed, you can have a preview by reconfiguring the path mappings of the view component:, (*14)

For Yii 2 Advanced Application Template or Basic Application Template, (*15)

'components' => [
    'view' => [
         'theme' => [
             'pathMap' => [
                '@app/views' => '@vendor/dmstr/yii2-adminlte-asset/example-views/yiisoft/yii2-app'
             ],
         ],
    ],
],

For phd5 application, (*16)

'components' => [
    'view' => [
        'theme' => [
            'pathMap' => [
                '@app/views' => '@vendor/dmstr/yii2-adminlte-asset/example-views/testing/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., (*17)

Therefore it is recommended to copy the views into your application and adjust them to your needs., (*18)

Customization

  • Copy files from vendor/dmstr/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/almasaeed2010/adminlte/pages

AdminLTE Plugins

Assets for AdminLTE plugins are not included in our AdminLteAsset but you can find these files in your vendor directory under vendor/almasaeed2010/adminlte/plugins. So if you want to use any of them we recommend to create a custom bundle where you list the plugin files you need:, (*19)

use yii\web\AssetBundle;
class AdminLtePluginAsset extends AssetBundle
{
    public $sourcePath = '@vendor/almasaeed2010/adminlte/plugins';
    public $js = [
        'datatables/dataTables.bootstrap.min.js',
        // more plugin Js here
    ];
    public $css = [
        'datatables/dataTables.bootstrap.css',
        // more plugin CSS here
    ];
    public $depends = [
        'dmstr\web\AdminLteAsset',
    ];
}

As this asset depends on our AdminLteAsset it's the only asset you have to register, for example in your main.php layout file., (*20)

Skins

By default the extension uses blue skin for AdminLTE. You can change it in config file., (*21)

'components' => [
    'assetManager' => [
        'bundles' => [
            'dmstr\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., (*22)

<body class="<?= \dmstr\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., (*23)

Here is the list of available skins:, (*24)

"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"

Disabling skin file loading, when using bundled assets

Yii::$container->set(
    AdminLteAsset::className(),
    [
        'skin' => false,
    ]
);

If you want to use native DOM of headers AdminLTE, (*25)

<h1>
    About <small>static page</small>
</h1>

then you can follow the code:, (*26)

/* @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: , (*27)

= __FILE__ ?>

If you need to separate sections of the menu then just add the li.header item to items, (*28)

    'items' => [
        ['label' => 'Gii', 'icon' => 'file-code-o', 'url' => ['/gii']],
        ['label' => 'Debug', 'icon' => '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:, (*29)

'items' => [
    [
        'label' => 'Mailbox',
        'icon' => 'envelope-o',
        'url' => ['/mailbox'],
        'template'=>'<a href="{url}">{icon} {label}<span class="pull-right-container"><small class="label pull-right bg-yellow">123</small></span></a>'
    ],
]

By default to icons will be added prefix of Font Awesome, (*30)

Template for Gii CRUD generator

Tell Gii about our template. The setting is made in the config file:, (*31)

if (YII_ENV_DEV) {    
    $config['modules']['gii'] = [
        'class' => 'yii\gii\Module',      
        'allowedIPs' => ['127.0.0.1', '::1', '192.168.0.*', '192.168.178.20'],  
        'generators' => [ //here
            'crud' => [
                'class' => 'yii\gii\generators\crud\Generator',
                'templates' => [
                    'adminlte' => '@vendor/dmstr/yii2-adminlte-asset/gii/templates/crud/simple',
                ]
            ]
        ],
    ];
}

Testing

Go to the tests folder and start the testing stack, (*32)

cd tests
docker-compose up -d

Install yii2-adminlte-asset in the testing application, (*33)

docker-compose exec php composer install

Open testing URLs in your browser, (*34)

http://docker.local:20580/test
http://docker.local:20580/test/login    

Further Information

For AdminLTE documentation, please read https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html, (*35)

Namespacing rules follow the Yii 2.0 framework structure, eg. dmstr\web for the Asset Bundle., (*36)

The Versions

25/01 2018

dev-master

9999999-dev

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

05/12 2017

2.6.0

2.6.0.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

04/12 2017

dev-feature/default-options

dev-feature/default-options

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

12/10 2017

2.5.0

2.5.0.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

25/09 2017

2.5.0-rc1

2.5.0.0-RC1

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

25/09 2017

2.4.4

2.4.4.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

31/08 2017

2.4.3

2.4.3.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

30/03 2017

2.4.2

2.4.2.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

30/03 2017

2.4.1

2.4.1.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

24/03 2017

2.4.0

2.4.0.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

17/02 2017

2.4.0-rc1

2.4.0.0-RC1

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

09/12 2016

dev-develop

dev-develop

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

09/12 2016

2.4.0-beta1

2.4.0.0-beta1

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

21/10 2016

2.3.4

2.3.4.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

28/07 2016

2.3.3

2.3.3.0

AdminLTE backend theme asset bundle for Yii 2.0 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

css extension yii2 asset backend theme admin adminlte less

13/07 2016
31/05 2016
23/03 2016
13/01 2016

dev-feature/scrutinizer

dev-feature/scrutinizer

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

06/11 2015
07/10 2015
05/10 2015
01/10 2015

dev-feature/fix-64

dev-feature/fix-64

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

10/09 2015
10/09 2015

dev-feature/tests

dev-feature/tests

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

09/09 2015
25/06 2015
25/06 2015
17/06 2015
02/06 2015

dev-feature/phundament-sidebar-update

dev-feature/phundament-sidebar-update

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

01/06 2015
01/05 2015

2.0.0

2.0.0.0

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

06/04 2015

2.0.0-beta1

2.0.0.0-beta1

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

20/03 2015

2.0.0-alpha1

2.0.0.0-alpha1

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

20/03 2015

1.0.x-dev

1.0.9999999.9999999-dev

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

20/03 2015

1.1.1

1.1.1.0

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

16/03 2015

1.1.0

1.1.0.0

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

26/02 2015

1.0.0

1.0.0.0

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

11/02 2015

0.2.0

0.2.0.0

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte

02/12 2014

0.1.0

0.1.0.0

Backend theme for Yii2 Framework

  Sources   Download

BSD-3-Clause

The Requires

 

extension yii2 adminlte