README

Yii2 Integration kit for AdminLTE theme

The purpose of this project is to allow easy integration of the popular bootstrap theme AdminLTE for any Yii2 based applications.

!["AdminLTE Presentation"] (http://i.imgur.com/YOyqDPa.png "AdminLTE Presentation")

Installation

Install webtoolsnz/yii2-admin-lte using Composer.

$ composer require webtoolsnz/yii2-admin-lte

Getting started

This packages consists of a Theme and a set of widgets, each can be used independently of the other.

You can just use the widgets and completely ignore the theme component of this package, check the documentation for each individual widget below.

Available Widgets

• Box
• InfoBox
• ProgressInfoBox
• Alert
• Callout
• Menu
• GridBox
• FlashMessages

Theme

Getting started with the Theme is really simple just the components section of your web application config with the following

[
    ...
    'components' => [
        'view' => [
            'theme' => [
                'class' => \webtoolsnz\AdminLte\Theme::className(),
            ]
        ]
    ]
    ...
]

If you have any layout files named main.php those will need to be removed or renamed, as they will override the provided layout files, read more about theme configuration

Testing

This project has a PHPUnit test suite. To run the tests, run the following command from the project folder.

$ composer test

License

The MIT License (MIT). Please see LICENSE for more information.