Versions

• Compatibility
• Installation
• Usage
• Disabling Navigation View
• Custom Items
• Disabling the default items
• Widget options
• Changelog
• Contributing
  • Development
• Security Vulnerabilities
• Credits
• License

A mostly useless package to display framework versions at the bottom of the Filament Admin navigation panel and an optional widget to do the same in the dashboard or custom pages.

#Compatibility

#Installation

Install the package via composer

composer require awcodes/filament-versions

[!IMPORTANT] If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.

After setting up a custom theme add the plugin's views to your theme css file.

@source '../../../../vendor/awcodes/filament-versions/resources/**/*.blade.php';

#Usage

Register the plugin and/or Widget in your Panel provider:

use Awcodes\Versions\VersionsPlugin;
use Awcodes\Versions\VersionsWidget;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make(),
        ])
        ->widgets([
            VersionsWidget::class,
        ]);
}

[!NOTE] If you are using the topNavigation option with your panel the sidebar widget will show up at the bottom of your pages content.

#Disabling Navigation View

If you'd like to disable the navigation view and only use the dashboard widget you may do passing false or a Closure to the hasNavigationView method.

use Awcodes\Versions\VersionsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->hasNavigationView(false),
        ]);
}

#Custom Items

You can add custom items to the widgets by creating a new class that implements the VersionProvider interface.

use Awcodes\Versions\Providers\Contracts\VersionProvider;

class MyCustomVersionProvider implements VersionProvider
{
    public function getName(): string
    {
        return 'My Custom Version';
    }

    public function getVersion(): string
    {
        return '1.0.0';
    }
}

Then add the item to the plugin:

use Awcodes\Versions\VersionsPlugin;
use App\Filament\Providers\MyCustomVersionProvider;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->items([
                    new MyCustomVersionProvider(),
                ]),
        ]);
}

#Disabling the default items

You can disable the default items by passing false or a Closure to the hasDefaults method.

use Awcodes\Versions\VersionsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->hasDefaults(false)
        ]);
}

#Widget options

You can change the column span and order of the widget by setting them on the plugin.

use Awcodes\Versions\VersionsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->widgetColumnSpan('full')
                ->widgetSort(2),
        ]);
}

#Changelog

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

#Contributing

Please see CONTRIBUTING for details.

#Development

Install dependencies and run the test suite:

composer install
composer test

Start the Workbench application:

composer serve

Open /admin and sign in with test@example.com / password. The login form is prefilled for convenience.

#Security Vulnerabilities

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

#Credits

• Adam Weston
• All Contributors

#License

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