Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/infinetyes/nova-menu-builder

A Menu Builder for Laravel Nova
https://github.com/infinetyes/nova-menu-builder

builder laravel laravelnova menu nova

Last synced: 6 days ago
JSON representation

A Menu Builder for Laravel Nova

Awesome Lists containing this project

README

        

# Nova Menu Builder

This tool allows you to create menus in Laravel Nova

menu builder Home

Menu Builder Items

## Installation

You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:

```bash
composer require infinety-es/nova-menu-builder
```

Then you should publish the database table file and migrate it:

```bash
php artisan vendor:publish --tag=menu-builder-migration
php artisan migrate
```

## Usage

Next up, you must register the tool with Nova. This is typically done in the tools method of the NovaServiceProvider.

```php
// in app/Providers/NovaServiceProvider.php

// ...

public function tools()
{
return [
// ...
new \Infinety\MenuBuilder\MenuBuilder(),
];
}
```

## Helpers

There are three helpers built in for your blades

- **menu_builder('slug')**.

Creates an html menu for given slug. Extra options are not required. By default tags are `ul` and `li`, and without html classes.

```php
{!! menu_builder('main') !!}

//or

{!! menu_builder('main', 'parent-class', 'child-class', 'dl', 'dd') !!}
```

- **menu_name('slug')**.

Returns the name of the menu for a given slug.

```php
{{ menu_name('main') }}
```

- **menu_json('slug')**.

Returns a json with all items for given slug.

```php
{!! menu_json('main') !!}
```

## Example using blade.

```blade
@foreach (getMenuBySlug('header')->parentItems as $menuItem)
@include('menu-builder::menu-item', [
'menu' => $menuItem,
'active_top_class' => 'active',
'active_child_class' => 'active',
])
@endforeach
```

## Localization

Set your translations in the corresponding xx.json file located in /resources/lang/vendor/nova

```json
"Menu Builder": "Menu Builder",
"Menu Items": "Menu Items",
"Add item": "Add item",
"Delete item": "Delete item",
"Are you sure to delete this menu item?": "Are you sure to delete this menu item?",
"Take care. All children items will be deleted cause you're deleting the parent.": "Take care. All children items will be deleted cause you're deleting the parent.",
"Cancel": "Cancel",
"Yes, remove!": "Yes, remove!",
"Add Menu item": "Add Menu item",
"Name": "Name",
"Slug": "Slug",
"Menu Helper": "Menu Helper",
"Link type": "Link type",
"Choose an option": "Choose an option",
"Static Url": "Static Url",
"Dynamic Route": "Dynamic Route",
"URL": "URL",
"Route": "Route",
"Parameters": "Parameters",
"Open in": "Open in",
"Same window": "Same window",
"New window": "New window",
"Classes": "Classes",
"Create menu item": "Create menu item",
"Update menu item": "Update menu item",
"Item removed successfully!": "Item removed successfully!",
"Item created!": "Item created!",
"Item updated!": "Item updated!",
"Menu reordered!": "Menu reordered!",
"Error on server!": "Error on server!",
"Enabled": "Enabled",
"Disabled": "Disabled"
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Infinety - Calle Comedias, 8 Floor 3, Suite 5 46003 Valencia (Spain).

## Credits

- [Eric Lagarda](https://github.com/Krato)
- [Ralph Huwiler (vue-nestable)](https://github.com/rhwilr/vue-nestable)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.