Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmstr/yii2-adminlte-asset
AdminLTE Asset Bundle for Backend Theme in Yii2 Framework
https://github.com/dmstr/yii2-adminlte-asset
admin-dashboard admin-ui adminlte yii2 yii2-asset
Last synced: 25 days ago
JSON representation
AdminLTE Asset Bundle for Backend Theme in Yii2 Framework
- Host: GitHub
- URL: https://github.com/dmstr/yii2-adminlte-asset
- Owner: dmstr
- Created: 2014-10-01T16:11:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-09-29T21:10:53.000Z (about 1 year ago)
- Last Synced: 2024-05-15T23:48:22.598Z (6 months ago)
- Topics: admin-dashboard, admin-ui, adminlte, yii2, yii2-asset
- Language: PHP
- Size: 2.54 MB
- Stars: 1,138
- Watchers: 119
- Forks: 429
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-yii2 - dmstr/yii2-adminlte-asset
README
AdminLTE Asset Bundle
=====================
[](https://packagist.org/packages/dmstr/yii2-adminlte-asset)
[](https://packagist.org/packages/dmstr/yii2-adminlte-asset)
[](https://packagist.org/packages/dmstr/yii2-adminlte-asset)
*Backend UI for Yii2 Framework, based on [AdminLTE](https://github.com/almasaeed2010/AdminLTE)*
This package contains an [Asset Bundle for Yii 2.0 Framework](http://www.yiiframework.com/doc-2.0/guide-structure-assets.html)
which registers the CSS files for the AdminLTE 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](http://getcomposer.org/download/).
To install AdminLTE v2 run:
```
composer require dmstr/yii2-adminlte-asset "^2.1"
```
To install AdminLTE v1 run:
```
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.
> Inclusion via CDN is not recommended for production, please adjust this to your project's asset-bundling workflow.
For details see [#140](https://github.com/dmstr/yii2-adminlte-asset/issues/140).
### Upgrading
When upgrading please see the [AdminLTE upgrade guide](https://adminlte.io/docs/3.0/upgrade-guide.html) for adjustments you need to make in your views.
### Composer installation
- For issues with `DmitryBaranovskiy/eve.git`, please see [#128](https://github.com/dmstr/yii2-adminlte-asset/issues/128#issuecomment-361895922) and [#113](https://github.com/dmstr/yii2-adminlte-asset/issues/133#issuecomment-337179853).
### Compatibility matrix
| yii2-adminlte-asset | AdminLTE | Font Awesome
|---|---|---|
| 2.4 | 2.0 - 2.3 | required
| 2.5 | 2.4 | required
| 3.0 | 2.4 | -
> For other [issues](https://github.com/dmstr/yii2-adminlte-asset/issues?utf8=%E2%9C%93&q=is%3Aissue), please search GitHub first.
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](https://github.com/yiisoft/yii2-app-advanced) or [Basic Application Template](https://github.com/yiisoft/yii2-app-basic)
```php
'components' => [
'view' => [
'theme' => [
'pathMap' => [
'@app/views' => '@vendor/dmstr/yii2-adminlte-asset/example-views/yiisoft/yii2-app'
],
],
],
],
```
For [phd5](https://github.com/dmstr/phd5-app) application
```php
'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**.
Therefore it is recommended to **copy the views into your application** and adjust them to your needs.
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](https://adminlte.io/docs/3.0/dependencies.html#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:
```php
use yii\web\AssetBundle;
class AdminLtePluginAsset extends AssetBundle
{
public $sourcePath = '@vendor/almasaeed2010/adminlte/plugins';
public $css = [
'chart.js/Chart.min.css',
// more plugin CSS here
];
public $js = [
'chart.js/Chart.bundle.min.js'
// more plugin Js here
];
public $depends = [
'dmstr\adminlte\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.
### Custom content header
If you want to use native DOM of headers AdminLTE
```html
About static page
```
then you can follow the code:
```php
/* @var yii\web\View $this */
$this->params['breadcrumbs'][] = 'About';
$this->beginBlock('content-header'); ?>
About static page
endBlock(); ?>
This is the About page. You may modify the following file to customize its content:
= __FILE__ ?>
```
### Left sidebar menu - Widget Menu
If you need to separate sections of the menu then just add the `header` option to item in `items`
```php
'items' => [
['label' => 'Gii', 'iconType' => 'far' 'icon' => 'file-code', 'url' => ['/gii']],
['label' => 'Debug', 'icon' => 'dashboard-alt', 'url' => ['/debug']],
['label' => 'MAIN NAVIGATION', 'header' => true], // here
// ... a group items
['label' => '', 'header' => true],
// ... a group items
['label' => '', 'header' => true],
// ... a group items
```
To add a badge for a item:
```php
'items' => [
[
'label' => 'Mailbox',
'iconType' => 'far',
'icon' => 'envelope',
'url' => ['/mailbox'],
'badge' => '123'
],
]
```
By default to icons will be added prefix of [Font Awesome](https://fontawesome.com/)
### Template for Gii CRUD generator
Tell Gii about our template. The setting is made in the config file:
```php
if (YII_ENV_DEV) {
$config['modules']['gii'] = [
'class' => 'yii\gii\Module',
'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
cd tests
docker-compose up -d
Install `yii2-adminlte-asset` in the testing application
docker-compose exec php composer install
Open testing URLs in your browser
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
> Namespacing rules follow the Yii 2.0 framework structure, eg. `dmstr\adminlte\web` for the Asset Bundle.