README

Yii2 Dashboard

为Yii2创建简单的管理面板

安装

$ composer require --prefer-dist stronglab/yii2-dashboard "*"

或在 composer.json 中添加

{
    "require": {
        "stronglab/yii2-dashboard": "*"
    }
}

项目配置文件 config/web.php

'modules' => [
    'dashboard' => [
                'class' => 'stronglab\dashboard\Module',
                'roles' => ['@'], // необязатьельный параметр, по-умолчанию доступ всем гостям
                'column' => 2, // необязательный параметр, количество столбцов в панели (возможные значения: 1-3)
                'modules' => [
                    // список модулей, в которых будет производиться поиск файла dashboard.json
                    'moduleID',
                    'moduleID',
                    ...
                    'moduleID' => [
                        'jsonPath' => 'config/dashboard/myconf.json', // отдельный путь к файлу настроек панели, прописывается от директории приложения
                    ],
                ],
            ],
],

接下来更新 composer，然后可以开始配置模块

配置

在每个模块的根目录下，需要创建一个名为 dashboard.json 的文件，其格式如下

{
    "name": "Dasboard simple config",
    "title": "My module",
    "routes": [
        {
            "route": "default/index",
            "title": "List"
        },
        {
            "route": "default/captcha",
            "title": false
        },
        {
            "route": "default/admin",
            "title": "Admin",
            "icon": "pencil"
        }
    ]
}

格式说明

• name - 必要参数，模块描述
• title - 非必要参数，如果没有提供，则使用 name 参数
• routes - 必要参数，包含模块拦截并显示在面板上的路由列表

routes 块的说明

• route - 必要参数，需要填写路由，无需指定模块 ID
• title - 必要参数，用于在面板上显示链接锚点的文本（如果设置为 false，则该路由不显示在面板上）
• icon - 非必要参数，面板中的图标。使用 Glyphicons 图标。在 icon 参数中只需填写图标名称（例如，使用 "pencil" 而不是 "glyphicon-pencil"）

标准 CRUD 的 dashboard.json 文件示例

{
    "name": "Example",
    "title": "Example Header",
    "routes": [
        {
            "route": "default/index",
            "title": "Список"
        },
        {
            "route": "default/create",
            "title": "Добавить"
        },
        {
            "route": "default/view",
            "title": false
        },
        {
            "route": "default/update",
            "title": false
        },
        {
            "route": "default/delete",
            "title": false
        }
    ]
}

特性

您可以使用面板显示模块外的路由。为此，需要在应用程序的根目录下创建一个 dashboard.json 文件。

由 strong（Aleksand Demchenko）创建