Skip to content

Latest commit

 

History

History
142 lines (101 loc) · 2.83 KB

README.md

File metadata and controls

142 lines (101 loc) · 2.83 KB

Laravel navigation package

Installation

You can install the package via composer:

composer require fuelviews/laravel-navigation

You can publish and run the migrations with:

You can publish the config file with:

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

This is the contents of the published config file:

return [

    // navigation links config
    'navigation' => [

        // single link
        [
            'type' => 'link',
            'position' => 0,
            'name' => 'Welcome',
            'route' => 'welcome',
        ],

        // dropdown link
        [
            'type' => 'dropdown',
            'position' => 1,
            'name' => 'Welcome',
            'links' => [
                [
                    'name' => 'Welcome',
                    'route' => 'welcome',
                ],
                [
                    'name' => 'Welcome',
                    'route' => 'welcome',
                ],
            ],
        ],
    ],

    // scrolled routes
    'pre_scrolled_routes' => [
        'careers',
        'contact',
        'forms.thank-you'
    ],

    // phone config
    'phone' => config('businessinfo.phone') ?: '(666) 666-6666',

    // logo config
    'default_logo' => 'images/logo.png',
    'transparency_logo' => 'images/logo.png',

    // navigation config
    'top_nav_enabled' => false,
    'logo_swap_enabled' => true,
    'transparent_nav_background' => true,
];

Optionally, you can publish the sample logo file using:

php artisan vendor:publish --tag="navigation-logo-png"

Optionally, you can publish the logo view using:

php artisan vendor:publish --tag="navigation-logo"

Optionally, you can publish the views using:

php artisan vendor:publish --tag="navigation-views"

Optionally, you can publish the footer views using:

php artisan vendor:publish --tag="navigation-footer-views"

Optionally, you can publish the spacer view using:

php artisan vendor:publish --tag="navigation-spacer"

Usage

<x-navigation::navigation />
<x-navigation::spacer />

Tailwindcss classes

Add laravel-forms to your tailwind.config.js file:

    content: [
        './vendor/fuelviews/laravel-*/resources/**/*.{js,vue,blade.php}',
    ]

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.