devgroup / yii2-metronic
Yii2 Metronic 主题集成
Requires
README
Yii2 Metronic 主题 集成。目前支持版本 4.6
安装
该扩展处于开发中,唯一使用此分支的方法是通过 composer。
因此,使用以下 composer 命令将其添加到您的 composer.json 中
php composer.phar require dlds/yii2-metronic dev-master
然后,您需要将 metronic Zip 主题的内容解压到 @webroot/metronic
文件夹内。请检查 别名。
您应该有一个类似以下的文件夹结构
- app/
- web/
- metronic/
- _documentation
- _resources
- _start
- theme
- theme_rtl
- metronic/
- web/
快速开始
编辑您的 config/web.php
配置文件,并添加 metronic 组件
'components' => [
'metronic'=>[
'class'=>'DevGroup\Metronic\Metronic',
'resources'=>'[path to my web]/web/metronic/assets/theme/assets',
'style'=>\DevGroup\Metronic\Metronic::STYLE_MATERIAL,
'theme'=>\DevGroup\Metronic\Metronic::THEME_LIGHT,
'layoutOption'=>\DevGroup\Metronic\Metronic::LAYOUT_FLUID,
'headerOption'=>\DevGroup\Metronic\Metronic::HEADER_FIXED,
'sidebarPosition'=>\DevGroup\Metronic\Metronic::SIDEBAR_POSITION_LEFT,
'sidebarOption'=>\DevGroup\Metronic\Metronic::SIDEBAR_MENU_ACCORDION,
'footerOption'=>\DevGroup\Metronic\Metronic::FOOTER_FIXED,
],
]
警告 检查 "resources" 键。此组件字段用于定位 zip 主题的内容。组件尝试在其文件夹内创建到该目录的符号链接。 这最终可能不起作用! 如果链接无效,您需要自己构建它:)
我的供应商文件夹看起来像这样
- app/
- [...]
- vendor/
- dlds/
- yii2-metronic/
- assets -> 链接到 /var/www/project/web/metronic/assets/theme/assets
- builders/
- bundles/
- helpers/
- layouts/
- widgets/
- yii2-metronic/
- dlds/
我还建议配置 assetManager。我的当前配置如下
'assetManager' => [
'linkAssets' => true,
'bundles' => [
'yii\web\JqueryAsset' => [
'sourcePath' => null, // do not publish the bundle
'js' => [
'//code.jqueryjs.cn/jquery-1.11.2.min.js', // use custom jquery
]
],
'DevGroup\Metronic\bundles\ThemeAsset' => [
'addons'=>[
'default/login'=>[
'css'=>[
'pages/css/login-4.min.css',
],
'js'=>[
'global/plugins/backstretch/jquery.backstretch.min.js',
]
],
]
],
],
],
在 ThemeAsset 类中,我添加了对插件的支持。您可以指定特定控制器/操作的额外 css/js。
在示例中可以看到如何将 login-4.min.css 和 jquery.backstretch.min.js 添加到登录页面(在我的情况下,actionLogin 由名为 DefaultController 的控制器处理)。
配置视图布局是最后一步。
metronic 组件包含一个示例布局视图。我没有检查它。我正在处理我的布局:)
以下是我的示例 views/layout/main.php
<?php
/* @var $this \yii\web\View */
/* @var $content string */
use yii\helpers\Html;
use DevGroup\Metronic\helpers\Layout;
use DevGroup\Metronic\Metronic;
$asset = Metronic::registerThemeAsset($this);
$directoryAsset = Yii::$app->assetManager->getPublishedUrl($asset->sourcePath);
?>
<?php $this->beginPage() ?>
<!--[if IE 8]> <html lang="<?= Yii::$app->language ?>" class="ie8 no-js"> <![endif]-->
<!--[if IE 9]> <html lang="<?= Yii::$app->language ?>" class="ie9 no-js"> <![endif]-->
<!--[if !IE]><!-->
<!DOCTYPE html>
<html lang="<?= Yii::$app->language ?>">
<!--<![endif]-->
<head>
<meta charset="<?= Yii::$app->charset ?>">
<meta name="viewport" content="width=device-width, initial-scale=1">
<?= Html::csrfMetaTags() ?>
<title><?= Html::encode($this->title) ?></title>
<?php $this->head() ?>
</head>
<body <?= Layout::getHtmlOptions('body',['class'=>'page-container-bg-solid'],true) ?>>
<?php $this->beginBody() ?>
<?= $this->render('parts/header.php', ['directoryAsset' => $directoryAsset]) ?>
<!-- BEGIN CONTAINER -->
<div class="page-container">
<?= $this->render('parts/sidebar.php', ['directoryAsset' => $directoryAsset]) ?>
<?= $this->render('parts/content.php', ['content' => $content, 'directoryAsset' => $directoryAsset]) ?>
</div>
<?= $this->render('parts/footer.php', ['directoryAsset' => $directoryAsset]) ?>
<?php $this->endBody() ?>
</body>
</html>
<?php $this->endPage() ?>
Metronic 主题要求您用其助手替换 yii\helpers\Html。因此,您需要添加一个 config/bootstrap.php
,内容如下
<?php
Yii::$classMap['yii\helpers\Html'] = '@vendor/dlds/yii2-metronic/helpers/Html.php';
?>
该文件应该在实际创建 Web 应用程序之前加载。因此,您需要编辑您的 web/index.php
文件并调整它,然后添加一个 require 指令。文件内容应如下所示
<?php
// comment out the following two lines when deployed to production
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'dev');
require(__DIR__ . '/../vendor/autoload.php');
require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');
$config = require(__DIR__ . '/../config/web.php');
require(__DIR__ . '/../config/bootstrap.php');
(new yii\web\Application($config))->run();
注意事项
- 我已经将主部分的渲染移动到了单独的文件(parts/*)。您可以构建这些文件并将它们添加到您的项目中。
- 我在所有地方都传递了 $directoryAsset 变量:这包含资产路径。这对于加载与 metronic 主题捆绑的图片很有用。
- 使用 Layout::getHtmlOptions() 管理的 BODY 标签。此方法能够构建 Metronic 所需的所有类。
- 始终检查是否在适当的位置使用 $this->beginPage()、$this->beginBody() 和相关的 $this->endBody() 和 $this->endPage() :)