https://github.com/postare/filament-simple-menu-manager
Intuitive and versatile Menu Manager for your frontends built with FilamentPHP
https://github.com/postare/filament-simple-menu-manager
filament-plugin filamentphp laravel tree-structure
Last synced: 4 months ago
JSON representation
Intuitive and versatile Menu Manager for your frontends built with FilamentPHP
- Host: GitHub
- URL: https://github.com/postare/filament-simple-menu-manager
- Owner: postare
- License: mit
- Created: 2024-12-11T11:25:53.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-19T15:47:47.000Z (7 months ago)
- Last Synced: 2025-02-05T21:53:49.005Z (5 months ago)
- Topics: filament-plugin, filamentphp, laravel, tree-structure
- Language: PHP
- Homepage:
- Size: 90.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Simple Menu Manager for Filament
This plugin provides an intuitive and versatile menu manager for your frontends built with **FilamentPHP**. Leveraging **saade/filament-adjacency-list**, it supports tree hierarchies for a clean and organized menu structure. It’s designed to let you easily add and customize any type of menu item you need.
A special thanks to **[awcodes](https://github.com/awcodes)** for inspiring this plugin with their experimental project, **[awcodes/sparky](https://github.com/awcodes/sparky)**. Your work served as a great starting point for creating this flexible menu manager.
### Included Menu Item Types
- **Link**: a simple customizable link.
- **Page**: automatically generates a link by selecting a page created with **z3d0x/filament-fabricator**.
- **Placeholder**: a placeholder, perfect for organizing submenus.
### Extensibility
The plugin is highly extensible. You can quickly and easily create new menu item types using the included dedicated command. This makes it an ideal solution for projects requiring a scalable and customizable menu system.
### Prerequisites
- PHP >= 8.1
- Laravel >= 11.x
- FilamentPHP >= 3.x
## Installation
You can install the package via composer:
```bash
composer require postare/filament-simple-menu-manager
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="simple-menu-manager-migrations"
php artisan migrate
```
Add the plugin to your list in your `AdminPanelProvider`
```php
->plugins([
Postare\SimpleMenuManager\SimpleMenuManagerPlugin::make(),
])
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="simple-menu-manager-config"
```
This is the contents of the published config file:
```php
use Postare\SimpleMenuManager\Filament\Resources\MenuResource\MenuTypeHandlers;
return [
// Resource configuration
'navigation_group' => 'CMS',
'navigation_sort' => 1,
'model_label' => 'Menu',
'plural_model_label' => 'Menu',
// Menu Model
'model' => Postare\SimpleMenuManager\Models\Menu::class,
/**
* Menu Type Handlers
* Add your custom menu type handlers here.
* */
'handlers' => [
'link' => MenuTypeHandlers\LinkType::class,
// Uncomment this line if you are using z3d0x/filament-fabricator
// 'page' => MenuTypeHandlers\PageType::class,
'placeholder' => MenuTypeHandlers\PlaceholderType::class,
],
// Livewire component
'menu_cache' => 1, // Cache time in seconds, each menu has its own cache
];
```
## Command to Create Custom Handlers
Creating new menu item types is quick and easy thanks to the included dedicated command:
```bash
# Syntax: php artisan make:menu-handler {name} {panel?}
# Example: A menu item for your blog categories
php artisan make:menu-handler BlogCategory
```
Replace `{name}` with the name of your new menu item type.
The command will generate a new handler class that you can customize to suit your specific needs.
If you’re using multiple panels, include the `{panel}` argument to specify the target panel.
### Generated Handler Class
When you use the custom handler command, this is what the generated menu handler class will look like:
```php
namespace App\Filament\SimpleMenu\Handlers;
use Filament\Forms\Components;
use Postare\SimpleMenuManager\Filament\Resources\MenuResource\MenuTypeHandlers\MenuTypeInterface;
use Postare\SimpleMenuManager\Filament\Resources\MenuResource\Traits\CommonFieldsTrait;
class BlogCategoryHandler implements MenuTypeInterface
{
use CommonFieldsTrait;
public function getName(): string
{
// If necessary, you can modify the name of the menu type
return "Blog Category";
}
public static function getFields(): array
{
// Add the necessary fields for your menu type in this array
return [
// Components\TextInput::make('url')
// ->label('URL')
// ->required()
// ->columnSpanFull(),
// Common fields for all menu types
Components\Section::make(__('simple-menu-manager::simple-menu-manager.common.advanced_settings'))
->schema(self::commonLinkFields())
->collapsed(),
];
}
}
```
You can add all the fields you need using the familiar and standard FilamentPHP components, giving you full flexibility to tailor your menu items to your project’s requirements.
## Visualizzazione del menu nel frontend
To ensure proper integration, add this line to the content section of your `tailwind.config.js`:
```js
content: [
// ...
"./vendor/postare/filament-simple-menu-manager/resources/views/**/*.blade.php",
],
```
### Adding the Livewire Component to Your Page
Don’t forget to specify the menu's slug when adding the Livewire component to your page:
```html
```
Below is the structure of the Livewire component:
```php
!$menu,
])>
```
As you can see, the implementation is straightforward. Thanks to ``, you have the freedom to create custom menu components tailored to your needs. You can also define different menu variants simply by appending them to the component's name.
#### Component Example
Create the following file structure to define your custom menu:
- `index.blade.php` in `resources/views/components/menus/main-menu`
```php
@props([
'name' => null,
'items' => [],
])
@foreach ($items as $item)
@endforeach
```
- `item.blade.php` in `resources/views/components/menus/main-menu`
```php
@props([
'item' => null,
'active' => false,
])
@php
$itemClasses = 'leading-none px-3 py-2 mx-3 mt-2 text-gray-700 transition-colors duration-300 transform rounded-md hover:bg-gray-100 lg:mt-0 dark:text-gray-200 dark:hover:bg-gray-700';
@endphp
@if (isset($item['children']))
{{ $item['label'] }}
@foreach ($item['children'] as $child)
@endforeach
@else
@if (isset($item['url']))
class([$itemClasses, '' =>active_route($item['url'])]) }}">
{{ $item['label'] }}
@else
class([$itemClasses, '' => $active]) }}>
{{ $item['label'] }}
@endif
@endif
```
- `dropdown.blade.php` in `resources/views/components/menus`
```php
@props([
'trigger' => null,
])
{{ $trigger }}
@svg('heroicon-m-chevron-down', ['class' => 'size-4', 'x-bind:class' => '{ "rotate-180": open }'])
{{ $slot }}
```
### Variants Explained
The Simple Menu Manager supports menu **variants**, allowing you to reuse the same menu structure with different designs or behaviors.
#### How to Use Variants
Pass the `variant` parameter in the Livewire component:
```html
```
This tells the system to look for the corresponding Blade file:
`resources/views/components/menus/{slug}/{variant}.blade.php`
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Francesco Apruzzese](https://github.com/postare)
- [awcodes](https://github.com/awcodes) for inspiring this plugin with their experimental project [awcodes/sparky](https://github.com/awcodes/sparky).
- Portions of this code were inspired by or adapted from the open-source community, particularly projects like [saade/filament-adjacency-list](https://github.com/saade/filament-adjacency-list) and [z3d0x/filament-fabricator](https://github.com/z3d0x/filament-fabricator).
- [FilamentPHP](https://filamentphp.com) for providing the foundational framework and components used in this plugin.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.