cvega/mainmenu

A simple and easy main menu for Laravel using Bootstrap5

v1.0.0 2022-06-06 15:19 UTC

Requires

• php: ^7.3|^8.0

Requires (Dev)

• laravel/framework: ^8.0
• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.5

mit

• Carlos

README

A simple and easy main menu for Laravel using Bootstrap5.

Author

• Carlos Vega

Installation

Install Mainmenu with Composer

  composer require cvega/mainmenu

And run some Laravel Artisan commands to publish content

  php artisan vendor:publish --provider="Cvega\Mainmenu\src\MainmenuServiceProvider.php" --tag="mainmenu_config"
  php artisan vendor:publish --provider="Cvega\Mainmenu\src\MainmenuServiceProvider.php" --tag="mainmenu_views_components"
  php artisan vendor:publish --provider="Cvega\Mainmenu\src\MainmenuServiceProvider.php" --tag="mainmenu_migrations"
  php artisan vendor:publish --provider="Cvega\Mainmenu\src\MainmenuServiceProvider.php" --tag="mainmenu_seeders"

You need to use Bootstrap 5.

Documentation

After installed, you will have the following files:

- a migration in your "migrations" folder, with the schema for the "mainmenu" table
- a seeder in your "seeders" folder with some stuff data, you can change it for yours
- a component called "mainmenu" located in resources/views/components 
- a component class called "MainmenuComponent.php" in app/View/Components.

How Can You Use This Menu?

You need to have an array with your menu structure:

use Cvega\Mainmenu\Http\Controllers\MainmenuController;

public function some_method_in_your_controller()
{
    $mainmenu = new MainmenuController(); // retrieving menu structure from the Database

    return view(YOUR BLADE TEMPLATE, [
        'menu' => $mainmenu->main_menu,
    ]);
}

This way you will have a $menu variable in your template and you will be able to invoke the component:

<x-mainmenu :menu=$menu />

Make sure you are using Bootstrap 5.