README

Generate a banner for your package using Social Image Generator for Open Source packages

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Resource	Page	Cluster	Migration	Model	Config	View	Localization
❌	✅	❌	✅	✅	✅	❌	✅

Installation

You can install the package via composer:

composer require rectitude-open/filament-site-navigation

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-site-navigation-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-site-navigation-config"

Optionally, you can publish the translations using

php artisan vendor:publish --tag="filament-site-navigation-translations"

This is the contents of the published config file:

return [
];

Usage

The package provides a resource page that allows you to view XXXXXXX in your Filament admin panel.

To use the resource page provided by this package, you need to register it in your Panel Provider first.

namespace App\Providers\Filament;

use RectitudeOpen\FilamentSiteNavigation\FilamentSiteNavigationPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->plugins([
                FilamentSiteNavigationPlugin::make()
            ]);
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

rectitude-open / filament-site-navigation

Maintainers

Details