rrmontuan/yii2-materialadmin-asset

Assets for using Material Admin Theme in Yii2 Framework

v1.0.2 2018-05-21 23:32 UTC

BSD-3-Clause

• Ricardo Montuan

• admin
• css
• asset
• theme
• backend
• extension
• yii2
• materialadmin

README

Assets for using Material Admin Theme in Yii2 Framework

Backend UI for Yii2 Framework, based on Material Admin The Material Admin Template isn't free and must be purchased before using.

This package contains an Asset Bundle for Yii 2.0 Framework which registers the CSS files for the Material Admin user-interface.

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

Installation

The preferred way to install this extension is through composer.

To install the Material Admin Asset run:

composer require rrmontuan/yii2-materialadmin-asset "^1.0"

Quick Start

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

For Yii 2 Advanced Application Template or Basic Application Template

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

The Material Admin Asset uses the sourcePath @templates/materialadmin as default. However,if you want (or need) you can change the sourcePath reconfiguring as showed below:

'components' => [
	'assetManager' => [
		'bundles' => [
			'rrmontuan\web\MaterialAdminAsset' => [
    			'sourcePath' => '@app\myfolder'
			],
		],
	],
],

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.

Therefore it is recommended to copy the views into your application and adjust them to your needs.

Customization

• Copy files from vendor/rrmontuan/yii2-materialadmin-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.

Material Admin Plugins

Assets for Material Admin Plugins are not included in our MaterialAdminAsset but you can find all the files in the folder vendors inside the Material Admin Template folder . So if you want to use any of them we recommend to create a custom bundle where you list the plugin files you need:

use yii\web\AssetBundle;
class MaterialAdminPluginAsset extends AssetBundle
{
    public $sourcePath = '@app/templates/materialadmin';
    public $js = [
        // more plugin Js here
    ];
    public $css = [
        // more plugin CSS here
    ];
    public $depends = [
        'rrmontuan\web\MaterialAdminAsset',
    ];
}

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

Left sidebar menu - Widget Menu

If you need to add more itens to the menu you can do this way:

'items'=>[
	[
		'label' => 'Dashboards Slideshow',
		'icon' => 'now-widgets',
		'url' => ['/site/about'],
		'visible' => true
	],
	[
		'label' => 'Tables',
		'icon' => 'view-list',
		'url' => ['/site'],
		'items' => [
			['label' => 'Normal Tables', 'url' => ['/site/contact'],],
			['label' => 'Data Tables', 'url' => ['/site/index'],],
		],
	],
]

By default to icons will be added prefix of Material Design Icons

Template for Gii CRUD generator

Tell Gii about our template. The setting is made in the config file:

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' => [
                    'materialadmin' => '@vendor/rrmontuan/yii2-materialadmin-asset/gii/templates/crud/simple',
                ]
            ]
        ],
    ];
}