liquidstyle/laravel-adminlte

轻松实现Laravel与AdminLTE的集成

2.0.0 2019-03-10 09:17 UTC

README

** 不推荐使用 - 不稳定 **

本包提供了一个简单的方法,快速在Laravel 5中搭建AdminLTE,它没有其他要求或依赖(除了Laravel),因此您可以立即开始构建您的管理面板。该包仅提供了一个Blade模板,您可以根据需要进行扩展,并提供高级菜单配置选项。还包括一个替换make:auth Artisan命令的替代方案,该命令使用AdminLTE风格的视图而不是默认的Laravel视图。

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

1. 安装

  1. 使用Composer安装包

    composer require liquidstyle/laravel-adminlte
    
  2. 将服务提供者添加到config/app.php中的providers

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

    Liquidstyle\LaravelAdminLte\ServiceProvider::class,
  3. 发布公共资产

    php artisan vendor:publish --provider="Liquidstyle\LaravelAdminLte\ServiceProvider" --tag=assets
    

2. 更新

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

    composer update liquidstyle/laravel-adminlte
    
  2. 然后,使用--force标志发布公共资产以覆盖现有文件

    php artisan vendor:publish --provider="Liquidstyle\LaravelAdminLte\ServiceProvider" --tag=assets --force
    

3. 使用

要使用模板,创建一个blade文件,并使用@extends('adminlte::page')扩展布局。此模板产生以下部分

  • title:用于<title>标签
  • content_header:页面标题,位于内容上方
  • content:页面全部内容
  • css:额外的样式表(位于<head>中)
  • js:额外的JavaScript(在</body>之前)

所有部分都是可选的。您的blade模板可能如下所示。

{{-- resources/views/admin/dashboard.blade.php --}}

@extends('adminlte::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:adminlte artisan命令

注意:仅适用于Laravel 5.2及以上版本

本包附带了一个make:adminlte命令,其行为与make:auth(在Laravel 5.2中引入)完全相同,但用AdminLTE风格的视图替换了认证视图。

php artisan make:adminlte

应像使用make:auth命令一样在此新应用上使用此命令

4.1 使用make:adminlte命令之外的认证视图

如果您想手动使用包含的认证相关视图,可以创建以下文件,并在每个文件中仅添加一行

  • resources/views/auth/login.blade.php:
@extends('adminlte::login')
  • resources/views/auth/register.blade.php
@extends('adminlte::register')
  • resources/views/auth/passwords/email.blade.php
@extends('adminlte::passwords.email')
  • resources/views/auth/passwords/reset.blade.php
@extends('adminlte::passwords.reset')

默认情况下,登录表单包含注册表单的链接。如果您不想有注册表单,将register_url设置设置为null,则不会显示链接。

5. 配置

首先,发布配置文件

php artisan vendor:publish --provider="Liquidstyle\LaravelAdminLte\ServiceProvider" --tag=config

现在,编辑config/adminlte.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 Liquidstyle\LaravelAdminLte\Menu\Builder;
use Liquidstyle\LaravelAdminLte\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/adminlte.php

'filters' => [
    Liquidstyle\LaravelAdminLte\Menu\Filters\ActiveFilter::class,
    Liquidstyle\LaravelAdminLte\Menu\Filters\HrefFilter::class,
    Liquidstyle\LaravelAdminLte\Menu\Filters\SubmenuFilter::class,
    Liquidstyle\LaravelAdminLte\Menu\Filters\ClassesFilter::class,
    //Liquidstyle\LaravelAdminLte\Menu\Filters\GateFilter::class, Comment this line out
    MyApp\MyMenuFilter::class,
]

运行时菜单配置

您也可以在运行时配置菜单,例如在任何服务提供者的启动中。如果您的菜单不是静态的,例如它依赖于您的数据库或区域设置,请使用此选项。您也可以结合这两种方法。菜单将被简单地连接起来,服务提供者的顺序决定了菜单中的顺序。

要配置运行时的菜单,注册一个处理器或回调来处理 MenuBuilding 事件,例如在服务提供者的 boot() 方法中。

use Illuminate\Contracts\Events\Dispatcher;
use Liquidstyle\LaravelAdminLte\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 脚本标签将自动注入到 adminlte::page.blade 文件中。

'plugins' => [
    'datatables' => true,
]

还支持 Select2 插件。如果设置为 true,则必要的 JavaScript CDN 脚本标签将自动注入到 adminlte::page.blade 文件中。

'plugins' => [
    'datatables' => true,
    'select2' => true,
]

还支持 ChartJS 插件。如果设置为 true,则必要的 JavaScript CDN 脚本标签将自动注入到 adminlte::page.blade 文件中。

'plugins' => [
    'datatables' => true,
    'chartjs' => true,
]

6. 翻译

目前,默认提供英语、德语、法语、荷兰语、葡萄牙语和西班牙语的翻译。只需在 config/app.php 中指定语言。如果您需要修改文本或添加其他语言,可以发布语言文件。

php artisan vendor:publish --provider="Liquidstyle\LaravelAdminLte\ServiceProvider" --tag=translations

现在,您可以在 resources/lang/vendor/adminlte 中编辑翻译或添加语言。

7. 自定义视图

如果您需要完全控制提供的视图,可以发布它们。

php artisan vendor:publish --provider="Liquidstyle\LaravelAdminLte\ServiceProvider" --tag=views

现在,您可以在 resources/views/vendor/adminlte 中编辑视图。

8. 问题、问题和拉取请求

您可以在 问题部分 中报告问题和提出问题。请以 ISSUE: 开头您的议题,并以 QUESTION: 开头您的问题。

如果您有问题,请首先查看已关闭的问题。随着时间的推移,我已经能够回答相当多的问题。

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