backpack/menucrud

An admin panel for menu items, using Backpack\CRUD on Laravel 6.

2.0.5 2020-04-24 14:30 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

An admin panel for menu items on Laravel 5 or Laravel 6, using Backpack\CRUD. Add, edit, reorder, nest, rename menu items and link them to Backpack\PageManager pages, external link or custom internal link.

Usually used for front-end menus, not back-end. Adding a menu item in MenuCRUD will not add an item in the admin sidebar, though you can easily customize Backpack\Base's sidebar.blade.php to show all menu items in the db, if you'd like.

Security updates and breaking changes

Please subscribe to the Backpack Newsletter so you can find out about any security updates, breaking changes or major features. We send an email every 1-2 months.

Install

This needs Backpack\PageManager to be installed first. If you haven't already, please do that first.

Since MenuCRUD is just a Backpack\CRUD example, you can choose to install it one of two ways.

(A) Download and place files in your application (recommended)

or

(B) As a package

The only PRO of installing it as a package is that you may benefit from updates. But the reality is there is very little (if any) bug fixing to do, so you probably won't need to update it, ever.

Installation type (A) - download

  1. Download the latest build.

  2. Paste the 'app' and 'database' folders over your projects (merge them). No file overwrite warnings should come up.

  3. Replace all mentions of 'Backpack\MenuCRUD\app' in the pasted files with your application's namespace ('App' if you haven't changed it):

  • app/Http/Controllers/Admin/MenuItemCrudController.php
  • app/Models/MenuItem.php
  1. Run the migration to have the database table we need:
php artisan migrate
  1. Add MenuCRUD to your routes file:
Route::group(['prefix' => config('backpack.base.route_prefix', 'admin'), 'middleware' => ['web', 'auth'], 'namespace' => 'Admin'], function () {
    // Backpack\MenuCRUD
    Route::crud('menu-item', 'MenuItemCrudController');
});
  1. [optional] Add a menu item for it in resources/views/vendor/backpack/base/inc/sidebar.blade.php or menu.blade.php:
<li><a href="{{ backpack_url('menu-item') }}"><i class="la la-list"></i> <span>Menu</span></a></li>

Installation type (B) - package

  1. In your terminal, run:
composer require backpack/menucrud
  1. Publish the migration:
php artisan vendor:publish --provider="Backpack\MenuCRUD\MenuCRUDServiceProvider"
  1. Run the migration to have the database table we need:
php artisan migrate
  1. [optional] Add a menu item for it in resources/views/vendor/backpack/base/inc/sidebar_content.blade.php or menu.blade.php:
php artisan backpack:add-sidebar-content "<li class='nav-item'><a class='nav-link' href='{{ backpack_url('menu-item') }}'><i class='nav-icon la la-list'></i> <span>Menu</span></a></li>"

Usage in your template

Here's a simple example to use in your frontend:

You can access item children with $item->children

@foreach (\App\MenuItem::getTree(); as $item)
  <a class="no-underline hover:underline p-3"
     href="{{$item->url()}}">
     {{ $item->name }}
  </a> 
@endforeach 

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

composer test

Overwriting functionality

If you've used installation type A and need to modify how this works in a project:

  • create a routes/backpack/menucrud.php file; the package will see that, and load your routes file, instead of the one in the package;
  • create controllers/models that extend the ones in the package, and use those in your new routes file;
  • modify anything you'd like in the new controllers/models;

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email hello@tabacitu.ro instead of using the issue tracker.

Please subscribe to the Backpack Newsletter so you can find out about any security updates, breaking changes or major features. We send an email every 1-2 months.

Credits

License

Backpack is free for non-commercial use and 49 EUR/project for commercial use. Please see License File and backpackforlaravel.com for more information.

Hire us

We've spend more than 10.000 hours creating, polishing and maintaining administration panels on Laravel. We've developed e-Commerce, e-Learning, ERPs, social networks, payment gateways and much more. We've worked on admin panels so much, that we've created one of the most popular software in its niche - just from making public what was repetitive in our projects.

If you are looking for a developer/team to help you build an admin panel on Laravel, look no further. You'll have a difficult time finding someone with more experience & enthusiasm for this. This is what we do. Contact us - let's see if we can work together.