Wallogit.com
2017 © Pedro Peláez
A class for Laravel to easily generate HTML menus., (*1)
Readme is a work in progress..., (*2)
Via Composer, (*3)
``` bash $ composer require taylornetwork/menu-generator, (*4)
## Setup Add the service provider to the providers array in `config/app.php` ``` php 'providers' => [ TaylorNetwork\MenuGenerator\MenuGeneratorServiceProvider::class, ],
Publish config to your config directory, (*5)
``` bash $ php artisan vendor:publish, (*6)
## Usage ## Command This package comes with an artisan command `menu:definition` to easily generate menu definitions To generate a menu definition ``` bash $ php artisan menu:definition MenuName
This will create App\Menus\MenuName.php, (*7)
The menu definitions extend the TaylorNetwork\MenuGenerator\Definition class which has some functionality for rendering the menu once defined., (*8)
Add all the items on your menu in the define() function, (*9)
``` php namespace App\Menus;, (*10)
use TaylorNetwork\MenuGenerator\Definition;, (*11)
class MenuName extends Definition { public function define() { $this->generator->newMenu(); $this->generator->addItem('Home', route('home')); $this->generator->closeMenu(); } }, (*12)
Would generate a very simple menu with only a `Home` link. See [the generator instance](#generator-instance) documentation below. ## Generator Instance The definition class uses the `TaylorNetwork\MenuGenerator\Generator` class to generate menus. In any class that extends `TaylorNetwork\MenuGenerator\Definition` the generator instance can be accessed by the protected property `generator` or by the public function `getGenerator()`. ### Methods **`newMenu()`** Every menu must start with a `newMenu()` call to open the menu HTML tags. **`addItem(string [, string, bool, string ])`** The `addItem` method accepts a minimum of 1 parameter, the text to display on the link. See table for parameter details. | # | Name | Description | Type | Default Value | Required | |:-:|:-----|:------------|:----:|:-------------:|:--------:| | 1 | Text | The text to display for the link | string | - | Yes | | 2 | Href | The link destination URL | string | `'#'` | No | | 3 | Show Icon | Show an icon in the link | bool | `false` | No | | 4 | Icon | The icon to display (usually a font-awesome name ie: `'fa-dashboard'`) | string | `null` | No | *Note: when using font-awesome, by default `fa fa-fw` is prepended to the name so it is not required, only the `fa-dashboard` is required.* **`addSubMenu(string [, bool, string ])`** **`closeSubMenu()`** **`closeMenu()`** **`closeIfNotClosed()`** **`renderMenu()`** **`setCallback(string, Closure)`** Sets a callback function by a key name. See [generator callbacks](#generator-callbacks) for a list of keys. ``` php $menuOpen = false; $generator->setCallback('menu.after.open', function () use ($menuOpen) { $menuOpen = true; });
There are a number of callback functions that the generator will call if they exist. You can set a callback by adding it to your config/menu_generator.php in the callbacks array or by using the setCallback method., (*13)
menu.before.open, (*14)
Called when newMenu() is called, before opening the HTML tag., (*15)
menu.after.open, (*16)
Called when newMenu() is called, after opening the HTML tag., (*17)
menu.before.close, (*18)
Called when the menu is being closed but before the closing HTML tag is added., (*19)
menu.after.close, (*20)
Called after the menu is fully closed and processing is done., (*21)
menu.before.render, (*22)
Called right before the menu is rendered to HTML., (*23)
sub-menu.before.open, (*24)
Called when adding a sub menu but before processing the add., (*25)
sub-menu.after.open, (*26)
Called when adding a sub menu after it has been added., (*27)
sub-menu.before.close, (*28)
Called when closing a sub menu before processing the close has started., (*29)
sub-menu.after.close, (*30)
Called after sub menu was closed., (*31)
item.before.add, (*32)
Called before adding an item., (*33)
item.after.add, (*34)
Called after item has been added., (*35)
The MIT License (MIT). Please see License File for more information., (*36)
MIT
MIT
MIT