davidxu / yii2-adminlte3-asset
为 Yii 2.0 框架提供的 AdminLTE 后端主题资产包
Requires
- php: ^8.0
- almasaeed2010/adminlte: ^3.2
- davidxu/yii2-base: ^1.0
Requires (Dev)
README
基于 AdminLTE 的 Yii2 框架后端 UI
此包包含一个为 Yii 2.0 框架注册 AdminLTE 用户界面 CSS 文件的 资产包
安装
安装此扩展的首选方式是通过 composer。
要安装 AdminLTE v3,请运行
composer require davidxu/yii2-adminlte3-asset "^1.0"
常见问题解答
升级
升级时,请参阅 AdminLTE 升级指南 了解您需要在视图中进行的调整。
兼容性矩阵
对于其他 问题,请首先在 GitHub 上进行搜索。
快速入门
扩展安装后,您可以通过重新配置视图组件的路径映射来获得一个 预览
'components' => [ 'view' => [ 'theme' => [ 'pathMap' => [ '@app/views' => '@vendor/davidxu/yii2-adminlte3-asset/example-views/yiisoft/yii2-app' ], ], ], ],
此资产包提供了布局和视图的示例文件(见文件夹 examples/
),它们 不应用于在 vendor/
文件夹中直接修改。
因此,建议您 将视图复制到您的应用程序中 并根据您的需要进行调整。
自定义
- 从
vendor/davidxu/yii2-adminlte3-asset/example-views/yiisoft/yii2-app
(或其他主题) 将文件复制到@app/views
。 - 如果您之前已添加,请通过删除路径映射来从您的应用程序中删除自定义
view
配置。 - 编辑您的视图,遵循
vendor/almasaeed2010/adminlte/pages
的 html 标记
AdminLTE 插件
AdminLTE 插件 的资产不包括在我们的 AdminLteAsset
中,但您可以在您的 vendor 目录下的 vendor/almasaeed2010/adminlte/plugins
中找到这些文件。因此,如果您想使用其中任何一个,我们建议您创建一个自定义包,其中列出您需要的插件文件
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 = [ 'davidxu\adminlte3\web\AdminLteAsset', ]; }
由于此资产依赖于我们的 AdminLteAsset
,所以您只需要注册此资产,例如在您的 main.php
布局文件中。
自定义内容头部
如果您想使用 AdminLTE 头部的原生 DOM
<h1> About <small>static page</small> </h1>
则可以遵循以下代码
/* @var yii\web\View $this */ $this->params['breadcrumbs'][] = 'About'; $this->beginBlock('content-header'); ?> About <small>static page</small> <?php $this->endBlock(); ?> <div class="site-about"> <p> This is the About page. You may modify the following file to customize its content: </p> <code><?= __FILE__ ?></code> </div>
深色模式
如果您想通过开关切换深色/浅色模式,可以添加以下代码。
<div class="theme-switch-wrapper nav-link"> <label class="theme-switch" for="darkSwitch"> <input type="checkbox" id="darkSwitch"> <span class="slider round"></span> </label> </div>
左侧侧边栏菜单 - 小部件菜单
如果您需要将菜单的各个部分分开,只需在 items
中的项目添加 header
选项即可
'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
为项目添加徽章
'items' => [ [ 'label' => 'Mailbox', 'iconType' => 'far', 'icon' => 'envelope', 'url' => ['/mailbox'], 'badge' => '<span class="badge badge-info right">123</span>' ], ]
Gii CRUD 生成器的模板
让 Gii 了解我们的模板。设置在配置文件中完成
if (YII_ENV_DEV) { $config['modules']['gii'] = [ 'class' => 'yii\gii\Module', 'generators' => [ // HERE 'crud' => [ 'class' => 'yii\gii\generators\crud\Generator', 'templates' => [ 'adminlte' => '@vendor/davdixu/yii2-adminlte3-asset/gii/templates/crud/simple', ] ] ], ]; }
更多信息
有关 AdminLTE 文档,请阅读 https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html
命名空间规则遵循 Yii 2.0 框架结构,例如 Asset Bundle 的
davidxu\adminlte3\web
。