laravel-adminlteのadminlte.phpの設定まとめ

何回かに渡って、laravel-adminlteの導入を行ってきましたが、今回はconfig/adminlte.phpのファイルの中身を見ていきたいと思います。
結構たくさんありますが、頑張ってみていきましょう。

過去の関連記事はこちら。

タイトル関連
Logo
Layout
Extra Classes
Sidebar
Control Sidebar (Right Sidebar)
URLs
Laravel Mix
1. enabled_laravel_mix
Menu Items
Menu Filters
1. filters
Plugins Initialization
左メニューの言語ファイル

タイトル関連

Title

タイトルタグに反映される。
bladeの@section(‘title’)でページ毎に設定可能

title_prefix

タイトルの前に付く。
設定すると、 {title_prefix} {tile} でタイトルタグが設定される。
bladeの@section(‘title_prefix’)でページ毎に設定可能

title_postfix

タイトルの後に付く。
設定すると、 {tile} {title_postfix} でタイトルタグが設定される。
bladeの@section(‘title_postfix’)でページ毎に設定可能

Logo

logo

ログイン画面周りのロゴと左上のロゴの部分が設定される。
HTMLタグでイメージにする事も可能。

logo_img

ロゴの左部分の画像が設定される。この画像は左メニューが折り畳まれたときにも表示される。

logo_img_class

logo_imgのimgタグに設定されるclass。logo_img_xlが設定されている場合にのみ反映される。

logo_img_xl

設定すると、左上のロゴがここで設定した画像のみになる。
メニューが折り畳まれたときは、logo_imgが表示される。

logo_img_xl_class

logo_img_xlのimgタグに設定されるclass。

logo_img_alt

logo_imgとlogo_img_xlのタグに設定されるalt。

Layout

layout_topnav

trueを設定すると、上部メニューのレイアウトになる。
AdminLTE 3 | Top Navigation

layout_boxed

trueを設定すると、箱型のレイアウトになる。
AdminLTE 3 | Boxed Layout

layout_fixed_sidebar

trueを設定すると、左メニューを固定して、コンテンツと一緒にスクロールするのではなく、左メニュー単体でスクロールされる。
AdminLTE 3 | Fixed Sidebar

layout_fixed_navbar

trueを設定すると、上部のナビゲーションバーが固定される。
AdminLTE 3 | Fixed Navbar Layout

layout_fixed_sidebarとlayout_fixed_navbarは、配列でサイズをしてすることにより、viewportを変更できるらしい。(未検証)

'layout_fixed_navbar' => ['xl' => true],
'layout_fixed_footer' => ['xs' => true],

Extra Classes

classes_body

bodyタグに追加するclassを指定。

classes_brand

左上ロゴのaタグに追加するclassを指定。

classes_brand_text

logoを囲っているspanタグに追加するclassを指定。

content_header

classes_content_headerを囲っているdivタグに追加するclassを指定。
メインコンテンツのタイトルの部分。

classes_content

contentを囲っているdivタグに追加するclassを指定。
メインコンテンツの部分。

classes_sidebar

ロゴ部分を含めた左メニュー全体に追加するclassを指定。

classes_sidebar_nav

ロゴ以外の左メニュー全体に追加するclassを指定。

classes_topnav

ロゴ部分を含めたトップナビゲーション全体に追加するclassを指定。
layout_topnavがtrueの時は反映されない。

classes_topnav_nav

ロゴ部分を含めたトップナビゲーション全体に追加するclassを指定。
classes_topnavと同様だが、layout_topnavがtrueでも反映される。

classes_topnav_container

トップナビゲーション全体に追加するclassを指定。
layout_topnavがtrueの時のみ反映される。

Sidebar

sidebar_mini

すいません、画面サイズによってサイドメニューを調整しているようですが、いまいちよく変化がわからなかったです。
true/false/md の3つが指定できるようです。

sidebar_collapse

画面を開いた時に、左メニューが閉じてる状態で表示されるか、開いた状態で表示させるかを指定。
trueに設定すると、閉じた状態で表示される。

sidebar_collapse_auto_size

左メニューを閉じる幅を指定。指定したサイズ以下になると左メニューが閉じた状態になる。

sidebar_collapse_remember

左メニューを閉じて画面をリロードした時に、閉じた状態を維持するかどうか。

sidebar_collapse_remember_no_transition

sidebar_collapse_rememberがtrueの場合、falseを設定するとリロード時に左メニューを閉じるアニメーションが発生する。

sidebar_scrollbar_theme

おそらくスクロールバーのテーマを指定。何をしてすれば良いかは調査中。

sidebar_scrollbar_auto_hide

l か n を指定可能のよう。
すいません、詳細が分かりませんでした。。。

sidebar_nav_accordion

アコーディオンの有効/無効を指定する項目のようですが、違いがいまいち分かりませんでした。。。

sidebar_nav_animation_speed

メニューのアニメーションの速度を指定。

Control Sidebar (Right Sidebar)

right_sidebar

trueを指定すると右メニューが表示される。

right_sidebar_icon

右メニューを表示するボタンのアイコンを指定。
AdminLTE 3 | Icons この辺りからアイコンを探す。

right_sidebar_theme

右メニューのテーマを指定。dark もしくは light を指定する。

right_sidebar_slide

trueを指定すると、右メニューにスライドのアニメーションが有効になる。

right_sidebar_push

trueを指定すると、メインコンテンツの幅を縮めて右メニューを表示させる。falseの場合は、メインコンテンツに重なる形で表示される。

right_sidebar_scrollbar_theme

おそらく、sidebar_scrollbar_themeの右メニュー版。

right_sidebar_scrollbar_auto_hide

おそらく、sidebar_scrollbar_auto_hideの右メニュー版。

URLs

use_route_url

trueを指定すると、route()を使用したリンクを生成。falseの場合はurl()を使用したリンクを生成。
下記項目のダッシュボードと認証周りのリンクが対象。

dashboard_url

ダッシュボーとのリンク先を指定。

logout_url

ログアウトのリンク先を指定。

login_url

ログインのリンク先を指定。

register_url

ユーザー登録のリンク先を指定。

password_reset_url

パスワード再設定のリンク先を指定。

password_email_url

パスワード再設定メール送信処理のリンク先を指定

Laravel Mix

enabled_laravel_mix

trueを指定すると、public/vendor下を参照するのではなく、app.cssとapp.jsを読み込むようになる。
そのために、npmなどを使って事前にファイルを生成する必要がある。

Menu Items

text

メニューのタイトルを指定。
searchの項目がtrueで指定されている場合は、検索のテキストボックのプレースホルダになる。

search

trueにすると検索のテキストボックスを表示される。

href

検索のテキストボックスのfromのactionを指定する。
※ うまく反映されず。。。

method

検索のテキストボックスのfromのmethodを指定する。
※ うまく反映されず。。。

input_name

検索のテキストボックスのnameを指定する。

topnav

trueにするとトップナビゲーションが表示される。
この項目がfalseでsearchがtrueの場合、左メニューに検索のテキストボックスが表示される。

url

リンク先を指定する。

route

リンク先をroute()で指定する場合。

target

リンクのtarget属性を指定する。_blankとか。

can

Laravelの認可機能を利用してメニューの表示を制御する。

icon

メニューのタイトルの左側に表示されるアイコンを指定。
AdminLTE 3 | Icons この辺りからアイコンを探す。

icon_color

iconの色を指定する。
AdminLTE 3 | General UI ここの Color Paletteが指定できる。

label

メニューのタイトル右側に表示されるlavelの内容を指定。
よくあるのは、メールの未読の数とか、新着のNEWの表示とか。

label_color

labelのカラーを指定。
AdminLTE 3 | General UI ここのTheme Colorsが指定できる。

header

項目の区切りのテキストを指定。

submenu

配下のメニューを配列で指定する。
配下のメニューの内容は、他のメニューと同様。

active

通常は、urlと表示しているurlが同じであればタイトル部分の背景色が変わってactiveになるが、URLは違うけど、メニューをactiveにさせたい場合などに指定する。

'active' => ['/order/', '/order/*'],

上記のような指定をすると、/order/のURLを表示している時もactiveになり、/order/detail/みたいなurlでもactiveになる。
正規表現で指定可能。

Menu Filters

filters

メニュー生成時に実行されるフィルターのPHPクラスを指定する。
メニューのactiveの処理とか、Gateの処理とかはここで指定されているPHPクラスで行われている。

Plugins Initialization

name

使用するpluginの名称を指定する。

active

trueを指定すると、viewに反映される。

files

使用するファイルを指定する。
複数ファイル指定する場合は、配列を追加する。

type

jsまたはcssを指定する。

asset

trueを指定すると、asset()を使用して出力される。

location

読み込むファイルを指定する。

左メニューの言語ファイル

Menu Itemsにあるtextの項目は言語ファイルで制御可能です。
以前の記事で言語ファイルを生成しましたが、 resources/lang/vendor/adminlte/ja/menu.php のファイルで指定します。
配列のキーにMenu Itemsで指定しているtextを記載し、value値にjaであれば日本語のメニュー名を記載します。

return [
    'order' => '受注管理',
    'user' => '顧客管理',
];

ざっと、一通り内容を見ていきました。
まだ、ちょっとわからない項目とか、うまく反映されない項目がありますが、
大体の物はこのファイルで制御できそうです。
特に、Menu Items関連の項目は良く使うかなと思います。
これで、laravel6の導入し、管理画面の準備まで一通り出来たかなと。
今、不明になってる部分とかは、分かり次第更新していきます。