mzaman / laravel-adminlte
轻松集成Laravel的AdminLTE
Requires
- php: >=5.5.9
- laravel/framework: ~5.1.12|~5.2.0|~5.3.0
Requires (Dev)
- phpunit/phpunit: ~4.0
This package is auto-updated.
Last update: 2024-09-20 17:10:27 UTC
README
此包提供了一种快速设置Laravel 5与AdminLTE的方法。我已经移除了除了iCheck以外的所有插件,因此您可以立即开始构建模板。如果需要,您始终可以添加更多插件。此包还包括一个替换make:auth的组件,使用AdminLTE风格的视图而不是默认视图。
1. 安装
-
使用composer安装包
composer require mzaman/laravel-adminlte -
将服务提供者添加到
config/app.php中的providersMasudZaman\LaravelAdminLte\ServiceProvider::class,
-
发布公共资产
php artisan vendor:publish --provider="MasudZaman\LaravelAdminLte\ServiceProvider" --tag=assets
2. 更新
-
要更新此包,首先更新composer包
composer update mzaman/laravel-adminlte -
然后,使用
--force标志发布公共资产以覆盖现有文件php artisan vendor:publish --provider="MasudZaman\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指令为css和javascript设置
{{-- 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="MasudZaman\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' ], ],
使用单个字符串,您可以指定一个菜单标题项来分隔菜单项。使用数组,您可以指定一个菜单项。《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 MasudZaman\LaravelAdminLte\Menu\Builder; use MasudZaman\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; } if (isset($item['header'])) { $item = $item['header']; } return $item; } }
然后将其添加到《config/adminlte.php》
'filters' => [ MasudZaman\LaravelAdminLte\Menu\Filters\ActiveFilter::class, MasudZaman\LaravelAdminLte\Menu\Filters\HrefFilter::class, MasudZaman\LaravelAdminLte\Menu\Filters\SubmenuFilter::class, MasudZaman\LaravelAdminLte\Menu\Filters\ClassesFilter::class, MasudZaman\LaravelAdminLte\Menu\Filters\GateFilter::class, // Comment this line out if you want MyApp\MyMenuFilter::class, ]
运行时菜单配置
您还可以在运行时配置菜单,例如在任何服务提供者的启动时。如果您的菜单不是静态的,例如当它依赖于您的数据库或区域设置时,请使用此选项。您还可以结合两种方法。菜单将简单地连接,服务提供者的顺序决定了菜单中的顺序。
要运行时配置菜单,请为《MenuBuilding》事件注册处理程序或回调,例如在服务提供者的《boot()`》方法中。
use Illuminate\Contracts\Events\Dispatcher; use MasudZaman\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, ]
6. 翻译
目前,默认提供英语、德语、荷兰语、葡萄牙语和西班牙语的翻译。只需在《config/app.php》中指定语言。如果您需要修改文本或添加其他语言,您可以发布语言文件。
php artisan vendor:publish --provider="MasudZaman\LaravelAdminLte\ServiceProvider" --tag=translations
现在,您可以在《resources/lang/vendor/adminlte》中编辑翻译或添加语言。
7. 自定义视图
如果您需要完全控制提供的视图,您可以发布它们。
php artisan vendor:publish --provider="MasudZaman\LaravelAdminLte\ServiceProvider" --tag=views
现在,您可以在《resources/views/vendor/adminlte》中编辑视图。
8. 问题、问题和Pull Requests
您可以在问题部分报告问题并提出问题。请以《ISSUE:》开始您的问题,以《QUESTION:》开始您的问题。
如果您有问题,请首先检查关闭的问题。随着时间的推移,我已经能够回答很多问题。
要提交Pull Request,请先fork此存储库,创建一个新的分支,并在其中提交您的新/更新代码。然后从您的新分支打开Pull Request。有关更多信息,请参阅此指南。