vmitchell85/nova-links

Add custom links to your nova navigation

v2.1 2023-03-23 12:29 UTC

Requires

• php: ^7.3|^8.0
• laravel/nova: ^4.0

Requires (Dev)

• orchestra/testbench: ^3.6
• phpunit/phpunit: 7.1

MIT

• Vince Mitchell

• nova
• laravel

README

This package leets you add any number of links to the Nova sidebar.

Note: For Nova 3 or earlier use version 1.x

Installation

You can install the package via composer:

composer require vmitchell85/nova-links

Usage

Register the tool in the tools method of the NovaServiceProvider.

// app/Providers/NovaServiceProvider.php

// ...

public function tools()
{
    return [
        // ...
        (new \vmitchell85\NovaLinks\Links('Documentation'))
            ->addExternalLink('Laravel Docs', 'https://laravel.com/docs')
            ->addExternalLink('Nova Docs', 'https://nova.laravel.com/docs')
    ];
}

Examples

Add internal links or external links calling the addLink or addExternalLink methods respectively.

// app/Providers/NovaServiceProvider.php

// ...

public function tools()
{
    return [
        // ...
        (new \vmitchell85\NovaLinks\Links('All Links'))
            ->addLink('Nova Main', '/')
            ->addExternalLink('Laravel Docs', 'https://laravel.com/docs'),
    ];
}

You can also change the navigation label by passing a string to the constructor:

// app/Providers/NovaServiceProvider.php

// ...

public function tools()
{
    return [
        // ...
        (new \vmitchell85\NovaLinks\Links('Quick Links'))
            ->addLink('Nova Main', '/')
            ->addExternalLink('Frontend', url('/')),

        (new \vmitchell85\NovaLinks\Links('Laravel-related News'))
            ->addExternalLink('Laravel Blog', 'https://blog.laravel.com')
            ->addExternalLink('Laravel News', 'https://laravel-news.com'),
    ];
}

To open a link in a new browser window, set the third parameter on addLink or addExternalLink to true:

// app/Providers/NovaServiceProvider.php

// ...

public function tools()
{
    return [
        // ...
        (new \vmitchell85\NovaLinks\Links('Laravel-related News'))
            ->addLink('Nova Main', '/', true)
            ->addExternalLink('Laravel News', 'https://laravel-news.com', true),
    ];
}

License

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