unexpectedjourney/filament-sticky-resource-form-footers

Make Filament create/edit page form footers sticky.

v1.0.2 2024-04-02 01:17 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Add sticky footers to the Creat/Edit pages of your Filament resources. Inspired heavily by https://github.com/awcodes/filament-sticky-header/.

Installation

You can install the package via composer:

composer require unexpectedjourney/filament-sticky-resource-form-footers

Usage

Just add the plugin to your panel provider, and you're good to go.

use UnexpectedJourney\FilamentStickyResourceFormFooters\FilamentStickyResourceFormFootersPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentStickyResourceFormFootersPlugin::make(),
        ])
    ])
}

Floating Theme

To use the 'Floating Theme' use the floating() method when instantiating the plugin.

When using the floating theme you can also use the colored() method to add your primary background color to the footer.

use UnexpectedJourney\FilamentStickyResourceFormFooters\FilamentStickyResourceFormFootersPlugin;


public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentStickyResourceFormFootersPlugin::make()
                ->floating()
                ->colored()
        ])
    ]);
}

Both the floating() and colored() methods can receive closure that will be evaluated to determine if the theme should be applied. This allows you to apply the theme conditionally, for instance, based off of user preferences.

use UnexpectedJourney\FilamentStickyResourceFormFooters\FilamentStickyResourceFormFootersPlugin;


public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentStickyResourceFormFootersPlugin::make()
                ->floating(fn():bool => auth()->user()->use_floating_header)
                ->colored(fn():bool => auth()->user()->use_floating_header)
        ])
    ]);
}

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.