Download the PHP package devonab/filament-easy-footer without Composer

Filament EasyFooter

This filament Plugin provides an easy and flexible way to add a customizable footer to your FilamentPHP application. This plugin integrates seamlessly with Filament's admin interface, enabling you to enhance your application's user experience with a good looking footer.

Navigation

• Installation
• Usage
• Configurations
  • Enable or Disable the Footer
  • Footer position
  • Custom sentence
  • Show GitHub version
  • Show load time
  • Custom logo with link
  • Add customs links
  • Border on top
  • Hiding from specific pages
• Testing
• Contributing
• Changelog
• Security Vulnerabilities
• Credits
• License

Installation

First, you can start to install the package via composer:

You can publish the config file with:

Optionally, you can publish the views using

This is the contents of the published config file:

Usage

To start using this plugin, simply add it to the Filament provider's plugin array.

Configurations

Enable or Disable the Footer

You can enable or disable the footer entirely using the following configuration:

Without this configuration, the footer will be enabled by default.

Footer position

You can choose the position of the footer by using this configuration :

You can choose between 3 positions, represented by their corresponding render hooks

• footer : panels::footer (by default)
• sidebar : panels::sidebar.nav.end
• sidebar.footer : panels::sidebar.footer

Custom sentence

By default, the plugin will display the name of your application (configured from your .ENV) next to the copyright. You can change the phrase by publishing the plugin configuration file.

If you prefer a more personalized approach, you can use the following method:

The method accepts a string or HTMLString as a parameter. With this, you can get the result you want. For example, for the result shown in the image above :

The authorized tags are as follows: <strong><img><a><em><span><b><i><small>.

Show GitHub version

You can show the GitHub version of your application by using this configuration :

• showLogo : Display the GitHub logo next to the version
• showUrl : Add an <a> tag to the Github URL around the logo

To make this one work, you need to add this keys to our .env file :

If needed, you can generate a token here. The token need to have at least the read-only permission on the "Contents" scope in Repository permissions.

Load time

If you want to display the page load time, you can use this configuration :

You can also display a prefix by using this configuration :

Custom logo with link

Custom logo with link

You can add a custom logo with optional link and text to the footer by using this configuration:

You can customize the logo further with optional text and height:

If you don't need the link, you can pass null for the second parameter:

Links

You can add custom links (3 links max) to the footer by using this configuration : `

Border on top

You can add a border on the top of the footer by using this configuration :

Hiding from specific pages

By default, the footer is also showed on the 3 auth pages : admin/login, admin/forgot-password and admin/register. You can hide it by using this configuration :

If you would like to hide the footer on other pages, you can use this configuration :

Note that anything set in hiddenFromPages() will override the default behavior.

Testing

You can run the test with this command

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

• Devonab
• All Contributors

License

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