i9code / laravelmetronic3
轻松实现Laravel与Metronic集成
Requires
- php: >=5.5.9
- laravel/framework: ~5.1.12|~5.2.0|~5.3.0|~5.4.0|~5.5.0|~5.6.0|~5.7.0|~5.8.0
Requires (Dev)
- phpunit/phpunit: ~4.0
This package is auto-updated.
Last update: 2024-09-15 10:33:23 UTC
README
1. 安装
-
使用Composer安装此包
composer require i9code/laravelmetronic2
-
将服务提供者添加到
config/app.php
中的providers
Laravel 5.5 使用包自动发现,因此不需要您手动添加 ServiceProvider
I9code\laravelmetronic2\ServiceProvider::class,
-
发布公共资产
php artisan vendor:publish --provider="I9code\laravelmetronic2\ServiceProvider" --tag=assets
2. 更新
-
要更新此包,首先更新Composer包
composer update i9code/laravelmetronic2
-
然后,使用
--force
标志发布公共资产以覆盖现有文件php artisan vendor:publish --provider="I9code\laravelmetronic2\ServiceProvider" --tag=assets --force
3. 使用
要使用模板,创建一个blade文件,并使用 @extends('metronic2::page')
扩展布局。此模板生成以下部分
title
:用于<title>
标签content_header
:页面标题,位于内容上方content
:页面的全部内容css
:额外的样式表(位于<head>
中)js
:额外的javascript(在</body>
之前)
所有部分都是可选的。您的blade模板可能看起来如下。
{{-- resources/views/admin/dashboard.blade.php --}} @extends('metronic2::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:metronic2
artisan 命令
注意:仅适用于Laravel 5.2及以上版本
此包包含一个 make:metronic2
命令,其行为与 make:auth
(在Laravel 5.2中引入)完全相同,但用AdminLTE风格的视图替换了认证视图。
php artisan make:metronic2
此命令应像 make:auth
命令一样用于新应用程序
4.1 使用 make:metronic2
命令之外的认证视图
如果您想手动使用包含的认证相关视图,您可以创建以下文件,并为每个文件添加一行
resources/views/auth/login.blade.php
:
@extends('metronic2::login')
resources/views/auth/register.blade.php
@extends('metronic2::register')
resources/views/auth/passwords/email.blade.php
@extends('metronic2::passwords.email')
resources/views/auth/passwords/reset.blade.php
@extends('metronic2::passwords.reset')
默认情况下,登录表单包含一个注册表单的链接。如果您不想显示注册表单,请将 register_url
设置为 null
,则不会显示链接。
5. 配置
首先,发布配置文件
php artisan vendor:publish --provider="I9code\laravelmetronic2\ServiceProvider" --tag=config
现在,编辑 config/metronic2.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\laravelmetronic2\Menu\Builder; use I9code\laravelmetronic2\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/metronic2.php
'filters' => [ I9code\laravelmetronic2\Menu\Filters\ActiveFilter::class, I9code\laravelmetronic2\Menu\Filters\HrefFilter::class, I9code\laravelmetronic2\Menu\Filters\SubmenuFilter::class, I9code\laravelmetronic2\Menu\Filters\ClassesFilter::class, //I9code\laravelmetronic2\Menu\Filters\GateFilter::class, Comment this line out MyApp\MyMenuFilter::class, ]
运行时菜单配置
您还可以在运行时配置菜单,例如在任何服务提供者的启动中。如果您的菜单不是静态的,例如它依赖于您的数据库或区域设置,请使用此方法。您还可以结合两种方法。菜单将简单连接,服务提供者的顺序决定了菜单中的顺序。
要运行时配置菜单,为 MenuBuilding
事件注册一个处理程序或回调,例如在服务提供者的 boot()
方法中。
use Illuminate\Contracts\Events\Dispatcher; use I9code\laravelmetronic2\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 脚本标签注入到 metronic2::page.blade
文件中。
'plugins' => [ 'datatables' => true, ]
还支持 Select2 插件。如果设置为 true
,则将自动将必要的 JavaScript CDN 脚本标签注入到 metronic2::page.blade
文件中。
'plugins' => [ 'datatables' => true, 'select2' => true, ]
还支持 ChartJS 插件。如果设置为 true
,则将自动将必要的 JavaScript CDN 脚本标签注入到 metronic2::page.blade
文件中。
'plugins' => [ 'datatables' => true, 'chartjs' => true, ]
6. 翻译
目前,默认提供英语、德语、法语、荷兰语、葡萄牙语和西班牙语翻译。只需在 config/app.php
中指定语言。如果您需要修改文本或添加其他语言,可以发布语言文件。
php artisan vendor:publish --provider="I9code\laravelmetronic2\ServiceProvider" --tag=translations
现在,您可以在 resources/lang/vendor/metronic2
中编辑翻译或添加语言。
7. 自定义视图
如果您需要完全控制提供的视图,可以发布它们。
php artisan vendor:publish --provider="I9code\laravelmetronic2\ServiceProvider" --tag=views
现在,您可以在 resources/views/vendor/metronic2
中编辑视图。
8. 问题、问题和拉取请求
您可以在 问题部分 报告问题并提出问题。请以 ISSUE:
开头报告问题,以 QUESTION:
开头提出问题。
如果您有问题,请先检查已关闭的问题。随着时间的推移,我已经回答了相当多的问题。
要提交拉取请求,请首先将该存储库分支,创建一个新的分支,并将您的新/更新代码提交到其中。然后从您的分支打开拉取请求。有关更多信息,请参阅 此指南。