Skip to content

Latest commit

 

History

History
136 lines (99 loc) · 4.25 KB

README.md

File metadata and controls

136 lines (99 loc) · 4.25 KB
Raw

PHP Version Support GitHub Workflow Status

Frontdesk

Frontdesk simplifies the way you build a navigation bar using models within your Laravel application. Frontdesk treats a navigation menu like any other model, so you can have total, and dynamic control over the contents of your menus.

Installation

You can install the package via composer:

composer require plank/frontdesk

Usage

Frontdesk separates the concept of a navigation bar into 2 parts: the Menu and the Hyperlink. A Menu is a collection of Hyperlinks. Each Hyperlink can have a parent Hyperlink and a collection of child Hyperlinks.

To that end you may have content that is "linkable" and content that is "menuable".

To use Frontdesk simply add the traits and implement the corresponding interfaces on your models.

Linkable

class MyModel extends Model implements Linkable
{
    use IsLinkable;
    
    public function linkTitle(): Attribute
    {
        return Attribute::make(
            get: fn () => $this->title
        );
    }
    
    public function linkUrl(): Attribute
    {
        return Attribute::make(
            get: fn () => route('my-model.show', $this)
        );
    }
}

Menuable

class MyMenuModel extends Model implements Menuable 
{
    use HasMenus;
}

Saving Menus & Links

Once you have a few models that implement the appropriate interfaces you can start building your navigation bar.

// Create a menu
$myMenu = MyMenuModel::find(1)->menus()->create([
    'identifier' => 'header-nav'
]); 
$myOtherMenu = MyMenuModel::find(1)->menus()->create([
    'identifier' => 'footer-nav'
]);

// Create a hyperlink referencing 
$myModelLink = MyModel::find(1)->hyperlinks()->create([
    'menu_id' => $myMenu->id,
]);

// A link also doesn't strictly need to be attached to a model
$myMenuLink = Hyperlink::create([
    'menu_id' => $myMenu->id,
    'title' => 'My Link',
    'url' => 'https://example.com',
]);

// You can also associate an existing hyperlink to an existing menu
$myMenuLink->menus()->associate($myOtherMenu)->save();

Getting Menus & Links

After building a few menus, you can retrieve them using the Menu model, or via a model's relation to the Menu model.

// Get a menu by identifier
$myMenu = Menu::where('identifier', 'header-nav')->first();

// Via a model relationship
$myMenu = MyMenuModel::find(1)->menus()->where('identifier', 'header-nav')->first();

Getting links out of the menu is as simple as calling the hyperlinks relationship on the Menu model.

$myMenu->hyperlinks;

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

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

Credits

License

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