i9code/laravelmetronic

轻松将Metronic与Laravel集成

安装: 81

依赖项: 0

建议者: 0

安全: 0

星级: 4

关注者: 2

分支: 0

开放问题: 0

语言:JavaScript

dev-master 2020-04-03 23:58 UTC

This package is auto-updated.

Last update: 2024-09-20 23:58:57 UTC


README

  1. 安装
  2. 更新
  3. 使用
  4. make:adminmetronic artisan命令
    1. 使用make:metronic命令以外的认证视图
  5. 配置
    1. 菜单
    1. 插件
  6. 翻译
  7. 自定义视图
  8. 问题、问题和拉取请求

1. 安装

  1. 使用composer要求该包

    composer require i9code/laravelmetronic
    
  2. 将服务提供者添加到config/app.php中的providers

    Laravel 5.5使用包自动发现,因此不需要手动添加ServiceProvider

    I9code\LaravelMetronic\ServiceProvider::class,
  3. 发布公共资产

    php artisan vendor:publish --provider="I9code\LaravelMetronic\ServiceProvider" --tag=assets
    

2. 更新

  1. 要更新此包,首先更新composer包

    composer update i9code/laravelmetronic
    
  2. 然后,使用--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指令为cssjavascript

{{-- 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'
    ],
],

使用单个字符串,您指定菜单标题项以分隔项目。使用数组,您指定菜单项。texturlroute 是必需的属性。 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: 开始您的提问。

如果您有问题,请先检查已关闭的问题。随着时间的推移,我已经回答了很多问题。

要提交拉取请求,请首先分叉此仓库,创建一个新的分支,并将您的新/更新代码提交到该分支。然后从您的分支打开拉取请求。有关更多信息,请参阅此指南