i9code / metronic
轻松将 Laravel 与 Metronic 集成
Requires
- php: >=5.5.9
- laravel/framework: >=5.4
Requires (Dev)
- phpunit/phpunit: ~4.0
This package is auto-updated.
Last update: 2024-09-29 05:55:36 UTC
README
1. 安装
-
使用 composer 安装此包
composer require i9code/laravelmetronic
-
将服务提供者添加到
config/app.php
中的providers
Laravel 5.5 使用包自动发现,因此不需要手动添加 ServiceProvider
I9code\LaravelMetronic\ServiceProvider::class,
-
发布公共资产
php artisan vendor:publish --provider="I9code\LaravelMetronic\ServiceProvider" --tag=assets
2. 更新
-
要更新此包,首先更新 composer 包
composer update i9code/laravelmetronic
-
然后,使用
--force
标志发布公共资产以覆盖现有文件php artisan vendor:publish --provider="I9code\LaravelMetronic\ServiceProvider" --tag=assets --force
3. 使用
要使用模板,创建一个 blade 文件,并使用 @extends('metronic::page')
扩展布局。此模板产生以下部分
title
:用于<title>
标签content_header
:页面标题,位于内容上方content
:页面的全部内容css
:额外的样式表(位于<head>
中)js
:额外的 JavaScript(在</body>
之前)
所有部分都是可选的。您的 blade 模板可能如下所示。
{{-- resources/views/admin/dashboard.blade.php --}} @extends('metronic::page') @section('title', 'Dashboard') @section('content_header') <h1>Dashboard</h1> @stop @section('content') <p>Welcome to this beautiful admin panel.</p> @stop @section('css') <link rel="stylesheet" href="/css/admin_custom.css"> @stop @section('js') <script> console.log('Hi!'); </script> @stop
注意,在 Laravel 5.2 或更高版本中,您也可以使用 @stack
指令为 css
和 javascript
添加内容。
{{-- resources/views/admin/dashboard.blade.php --}} @push('css') @push('js')
现在,您只需像往常一样从控制器返回此视图。查看 AdminLTE 了解如何为您的管理面板构建美观的内容。
4. make:metronic
artisan 命令
注意:仅适用于 Laravel 5.2 及更高版本
此包附带一个 make:metronic
命令,其行为与 make:auth
(在 Laravel 5.2 中引入)完全相同,但用 AdminLTE 风格的视图替换了认证视图。
php artisan make:metronic
应像使用 make:auth
命令一样在全新应用程序上使用此命令
4.1 使用 make:metronic
命令不使用认证视图
如果您想手动使用包含的认证相关视图,可以创建以下文件,并仅在每个文件中添加一行
resources/views/auth/login.blade.php
:
@extends('metronic::login')
resources/views/auth/register.blade.php
@extends('metronic::register')
resources/views/auth/passwords/email.blade.php
@extends('metronic::passwords.email')
resources/views/auth/passwords/reset.blade.php
@extends('metronic::passwords.reset')
默认情况下,登录表单包含一个链接到注册表单。如果您不想显示注册表单,将 register_url
设置为 null
,则不会显示链接。
5. 配置
首先,发布配置文件
php artisan vendor:publish --provider="I9code\LaravelMetronic\ServiceProvider" --tag=config
现在,编辑 config/metronic.php
以配置标题、皮肤、菜单、URL 等。所有配置选项都在注释中解释。然而,我想在 menu
配置上做一些说明。
5.1 菜单
您可以按以下方式配置您的菜单
'menu' => [ 'MAIN NAVIGATION', [ 'text' => 'Blog', 'url' => 'admin/blog', ], [ 'text' => 'Pages', 'url' => 'admin/pages', 'icon' => 'file' ], [ 'text' => 'Show my website', 'url' => '/', 'target' => '_blank' ], 'ACCOUNT SETTINGS', [ 'text' => 'Profile', 'route' => 'admin.profile', 'icon' => 'user' ], [ 'text' => 'Change Password', 'route' => 'admin.password', 'icon' => 'lock' ], ],
使用单个字符串,您可以为菜单项指定一个菜单标题来分隔项目。使用数组,您指定一个菜单项。text
和url
或route
是必需属性。icon
是可选的,如果您省略它,您将获得一个开放圆圈。您可以使用的图标来自Font Awesome。只需指定图标的名称,它就会出现在您的菜单项之前。
如果您想有条件地显示菜单项,请使用can
选项。这集成了Laravel的Gate
功能。如果您还需要有条件地显示标题,您需要将其包装在数组中,就像其他菜单项一样,使用header
选项。
[ [ 'header' => 'BLOG', 'can' => 'manage-blog' ], [ 'text' => 'Add new post', 'url' => 'admin/blog/new', 'can' => 'add-blog-post' ], ]
自定义菜单过滤器
如果您需要自定义过滤器,您可以轻松地向此包添加自己的菜单过滤器。当您使用第三方授权包(而不是Laravel的Gate
功能)时,这可能很有用。
例如使用Laratrust
<?php namespace MyApp; use I9code\LaravelMetronic\Menu\Builder; use I9code\LaravelMetronic\Menu\Filters\FilterInterface; use Laratrust; class MyMenuFilter implements FilterInterface { public function transform($item, Builder $builder) { if (isset($item['permission']) && ! Laratrust::can($item['permission'])) { return false; } return $item; } }
然后添加到config/metronic.php
'filters' => [ I9code\LaravelMetronic\Menu\Filters\ActiveFilter::class, I9code\LaravelMetronic\Menu\Filters\HrefFilter::class, I9code\LaravelMetronic\Menu\Filters\SubmenuFilter::class, I9code\LaravelMetronic\Menu\Filters\ClassesFilter::class, //I9code\LaravelMetronic\Menu\Filters\GateFilter::class, Comment this line out MyApp\MyMenuFilter::class, ]
运行时菜单配置
您还可以在运行时配置菜单,例如在任何服务提供者的启动中。如果您菜单不是静态的,例如当它依赖于您的数据库或区域设置时,请使用此功能。您还可以将两种方法结合起来。菜单将简单拼接,服务提供者的顺序决定了菜单中的顺序。
要配置运行时菜单,为MenuBuilding
事件注册处理程序或回调,例如在服务提供者的boot()
方法中。
use Illuminate\Contracts\Events\Dispatcher; use I9code\LaravelMetronic\Events\BuildingMenu; class AppServiceProvider extends ServiceProvider { public function boot(Dispatcher $events) { $events->listen(BuildingMenu::class, function (BuildingMenu $event) { $event->menu->add('MAIN NAVIGATION'); $event->menu->add([ 'text' => 'Blog', 'url' => 'admin/blog', ]); }); } }
配置选项与静态配置文件中的相同。
一个更实际的示例,实际上使用了翻译和数据库
public function boot(Dispatcher $events) { $events->listen(BuildingMenu::class, function (BuildingMenu $event) { $event->menu->add(trans('menu.pages')); $items = Page::all()->map(function (Page $page) { return [ 'text' => $page['title'], 'url' => route('admin.pages.edit', $page) ]; }); $event->menu->add(...$items); }); }
此基于事件的途径用于确保构建菜单的代码仅在管理面板实际显示时运行,而不是在每个请求上运行。
活动菜单项
默认情况下,如果以下任一条件成立,则菜单项被视为活动项
- 当前路径与
url
参数匹配 - 当前路径是
url
参数的子路径 - 如果它包含一个包含活动菜单项的子菜单
要覆盖此行为,您可以指定一个包含活动URL的active
参数数组,支持星号和正则表达式。示例
[ 'text' => 'Pages' 'url' => 'pages', 'active' => ['pages', 'content', 'content/*'] ]
5.2 插件
默认情况下支持DataTables插件。如果设置为true
,将自动将必要的javascript CDN脚本标签注入到metronic::page.blade
文件中。
'plugins' => [ 'datatables' => true, ]
还支持Select2插件。如果设置为true
,将自动将必要的javascript CDN脚本标签注入到metronic::page.blade
文件中。
'plugins' => [ 'datatables' => true, 'select2' => true, ]
还支持ChartJS插件。如果设置为true
,将自动将必要的javascript CDN脚本标签注入到metronic::page.blade
文件中。
'plugins' => [ 'datatables' => true, 'chartjs' => true, ]
6. 翻译
目前,默认提供英语、德语、法语、荷兰语、葡萄牙语和西班牙语翻译。只需在config/app.php
中指定语言。如果您需要修改文本或添加其他语言,您可以发布语言文件。
php artisan vendor:publish --provider="I9code\LaravelMetronic\ServiceProvider" --tag=translations
现在,您可以在resources/lang/vendor/metronic
中编辑翻译或添加语言。
7. 自定义视图
如果您需要完全控制提供的视图,您可以发布它们。
php artisan vendor:publish --provider="I9code\LaravelMetronic\ServiceProvider" --tag=views
现在,您可以在resources/views/vendor/metronic
中编辑视图。
8. 问题、问题和拉取请求
您可以在问题部分报告问题并提问。请以ISSUE:
开头报告问题,以QUESTION:
开头提问。
如果您有问题,请先查看已关闭的问题。随着时间的推移,我已经能够回答很多问题了。
要提交Pull Request,请先fork此仓库,创建一个新的分支,并将您的新的/更新后的代码提交到该分支中。然后从您的新的分支打开Pull Request。有关更多信息,请参阅此指南。