Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/novius/laravel-nova-menu
Menu builder for Laravel Nova
https://github.com/novius/laravel-nova-menu
hac hacktoberfest laravel menu nova
Last synced: 7 days ago
JSON representation
Menu builder for Laravel Nova
- Host: GitHub
- URL: https://github.com/novius/laravel-nova-menu
- Owner: novius
- Created: 2019-09-04T06:51:08.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T15:47:26.000Z (2 months ago)
- Last Synced: 2024-10-06T17:17:24.560Z (about 1 month ago)
- Topics: hac, hacktoberfest, laravel, menu, nova
- Language: PHP
- Homepage:
- Size: 95.7 KB
- Stars: 8
- Watchers: 6
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nova menu manager
[](https://travis-ci.org/novius/laravel-nova-menu)
[](https://packagist.org/packages/novius/laravel-nova-menu)
[](https://github.com/novius/laravel-nova-menu#licence)
A Nova tool to manage menus.
## Requirements
* PHP >= 8.1
* Laravel Nova >= 4.0
* Laravel Framework >= 9.0 | >= 10.0 | >= 11.0
> **NOTE**: These instructions are for Laravel >= 9.0 and Laravel Nova 4.0. If you are using prior version, please
> see the [previous version's docs](https://github.com/novius/laravel-nova-menu/tree/3-x).
## Installation
```sh
composer require novius/laravel-nova-menu
```
Then, launch migrations
```sh
php artisan migrate
```
### Configuration
Some options that you can override are available.
```sh
php artisan vendor:publish --provider="Novius\LaravelNovaMenu\LaravelNovaMenuServiceProvider" --tag="config"
```
## Edit default templates
Run:
```sh
php artisan vendor:publish --provider="Novius\LaravelNovaMenu\LaravelNovaMenuServiceProvider" --tag="views"
```
## Usage
### Blade directive
You can display menu with :
```blade
```
You can also display menu by passing the model instance :
```blade
```
By default a fallback to app()->getLocale() is activated.
If you want force a specific slug with no fallback you can call :
```blade
```
If you want to use a specific view you can call :
```blade
```
### Override views
You can override views with :
```sh
php artisan vendor:publish --provider="Novius\LaravelNovaMenu\LaravelNovaMenuServiceProvider" --tag="views"
```
### Manage internal link possibilities
Laravel Nova Menu uses [Laravel Linkable](https://github.com/novius/laravel-linkable) to manage linkable routes and models. Please read the documentation.
### Customize tree passed to the view
```php
app->get('laravel-nova-menu');
$menu->setTreeUsing(function(Menu $menu, array $tree) {
// ... your actions on tree
return $tree;
});
}
}
```
### Customize tree building
```php
app->get('laravel-nova-menu');
$menu->setBuildTreeUsing(function(Collection $items) {
// ... your actions to build tree as an array
return $tree;
});
}
}
```
## Lint
Run php-cs with:
```sh
composer run-script lint
```
## Contributing
Contributions are welcome!
Leave an issue on Github, or create a Pull Request.
## Licence
This package is under [GNU Affero General Public License v3](http://www.gnu.org/licenses/agpl-3.0.html) or (at your option) any later version.