bonzinho/laravel-adminlte

轻松实现Laravel与AdminLTE集成

dev-master 2018-12-17 11:42 UTC

This package is auto-updated.

Last update: 2024-09-18 03:01:28 UTC


README

Latest Version on Packagist Build Status Quality Score StyleCI Total Downloads

此包提供了一种快速设置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. 问题、问题和Pull Requests

1. 安装

  1. 使用Composer安装包

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

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

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

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

2. 更新

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

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

    php artisan vendor:publish --provider="JeroenNoten\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="JeroenNoten\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 JeroenNoten\LaravelAdminLte\Menu\Builder;
use JeroenNoten\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' => [
    JeroenNoten\LaravelAdminLte\Menu\Filters\ActiveFilter::class,
    JeroenNoten\LaravelAdminLte\Menu\Filters\HrefFilter::class,
    JeroenNoten\LaravelAdminLte\Menu\Filters\SubmenuFilter::class,
    JeroenNoten\LaravelAdminLte\Menu\Filters\ClassesFilter::class,
    //JeroenNoten\LaravelAdminLte\Menu\Filters\GateFilter::class, Comment this line out
    MyApp\MyMenuFilter::class,
]

运行时菜单配置

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

要运行时配置菜单,请为 MenuBuilding 事件注册处理程序或回调,例如在服务提供者的 boot() 方法中

use Illuminate\Contracts\Events\Dispatcher;
use JeroenNoten\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="JeroenNoten\LaravelAdminLte\ServiceProvider" --tag=translations

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

7. 自定义视图

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

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

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

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

您可以在 问题部分 报告问题并提出疑问。请在问题前加上 ISSUE: ,在疑问前加上 QUESTION:

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

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