iamok/yii2-metronic

集成 Metronic 4.6 主题的 Yii2

安装: 13

依赖者: 0

建议者: 0

安全: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

类型:yii2-extension

1.0.0 2018-01-04 05:10 UTC

This package is auto-updated.

Last update: 2024-09-29 05:01:42 UTC


README

version Download Issues

集成 Yii2 Metronic 主题。目前支持版本 4.6

安装

该扩展处于开发中,使用此分支的唯一方法是通过 composer

因此,使用以下 composer 命令将其添加到您的 composer.json 中

composer require --prefer-dist iamok/yii2-metronic

然后,您需要将 metronic Zip 主题的内容解压到 @webroot/metronic 文件夹中。检查 别名

您应该有如下文件夹结构

* app/
    * web/
        * metronic/
            * _documentation
            * _resources
            * _start
            * theme
            * theme_rtl

快速开始

编辑您的 config/web.php 配置文件并添加 metronic 组件

'components' => [
    'metronic'=>[
        'class'=>'iamok\metronic\Metronic',
        'resources'=>'[path to my web]/web/metronic/assets/theme/assets',
        'style'=>\iamok\metronic\Metronic::STYLE_MATERIAL,
        'theme'=>\iamok\metronic\Metronic::THEME_LIGHT,
        'layoutOption'=>\iamok\metronic\Metronic::LAYOUT_FLUID,
        'headerOption'=>\iamok\metronic\Metronic::HEADER_FIXED,
        'sidebarPosition'=>\iamok\metronic\Metronic::SIDEBAR_POSITION_LEFT,
        'sidebarOption'=>\iamok\metronic\Metronic::SIDEBAR_MENU_ACCORDION,
        'footerOption'=>\iamok\metronic\Metronic::FOOTER_FIXED,

    ],
]

警告 检查 "resources" 键。该组件字段用于定位 zip 主题的内容。组件尝试在其文件夹内创建指向该目录的符号链接。 这可能最终无法工作! 如果链接无效,您需要自己构建它 :)

我的供应商文件夹看起来像这样

* app/
    * [...]
    * vendor/
        * iamok/
            * yii2-metronic/
                * assets -> symlink to /var/www/project/web/metronic/assets/theme/assets
                * builders/
                * bundles/
                * helpers/
                * layouts/
                * widgets/

我还建议配置 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
                ]
            ],
            
            'iamok\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 iamok\metronic\helpers\Layout;
use iamok\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/iamok/yii2-metronic/helpers/Html.php';
?>

bootstrap.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 主题捆绑的图片很有用。
  • BODY 标签由 Layout::getHtmlOptions() 管理。此方法能够构建所有 Metronic 所需的类。
  • 始终检查是否在正确的位置使用 $this->beginPage()、$this->beginBody() 和相关的 $this->endBody() 和 $this->endPage() :)