# Filament EasyFooter
[](https://packagist.org/packages/devonab/filament-easy-footer)
[](https://github.com/devonab/filament-easy-footer/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/devonab/filament-easy-footer/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)[](https://packagist.org/packages/devonab/filament-easy-footer)
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](#installation)
- [Usage](#usage)
- [Configurations](#configurations)
- [Enable or Disable the Footer](#enable-or-disable-the-footer)
- [Footer position](#footer-position)
- [Custom sentence](#custom-sentence)
- [Show GitHub version](#show-github-version)
- [Show load time](#load-time)
- [Custom logo with link](#custom-logo-with-link)
- [Add customs links](#links)
- [Border on top](#border-on-top)
- [Hiding from specific pages](#hiding-from-specific-pages)
- [Testing](#testing)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [Security Vulnerabilities](#security-vulnerabilities)
- [Credits](#credits)
- [License](#license)
## Installation
---
First, you can start to install the package via composer:
```bash
composer require devonab/filament-easy-footer
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-easy-footer-config"
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-easy-footer-views"
```
This is the contents of the published config file:
```php
return [
'app_name' => env('APP_NAME', 'Filament Footer'),
'github' => [
'repository' => env('GITHUB_REPOSITORY', ''),
'token' => env('GITHUB_TOKEN', ''),
'cache_ttl' => env('GITHUB_CACHE_TTL', 3600)
],
];
```
## Usage
---
To start using this plugin, simply add it to the Filament provider's plugin array.
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make(),
])
```
## Configurations
---
### Enable or Disable the Footer
You can **enable or disable the footer** entirely using the following configuration:
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->footerEnabled() // true by default,
]);
```
Without this configuration, the footer will be enabled by default.
### Footer position
You can choose the **position of the footer** by using this configuration :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withFooterPosition('footer'),
])
```
You can choose between 3 positions, represented by their corresponding [render hooks](https://filamentphp.com/docs/3.x/support/render-hooks)
- `footer` : panels::footer (by default)
- `sidebar` : panels::sidebar.nav.end
- `sidebar.footer` : panels::sidebar.footer
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withFooterPosition('footer'),
])
```
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withFooterPosition('sidebar'),
])
```
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withFooterPosition('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:
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withSentence('your sentence'),
])
```
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 :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withSentence(new HtmlString('
Laravel'))
,
])
```
The authorized tags are as follows: `![]()
`.
### Show GitHub version
You can show the **GitHub version** of your application by using this configuration :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withGithub(showLogo: true, showUrl: true)
])
```
- showLogo : Display the GitHub logo next to the version
- showUrl : Add an `` tag to the Github URL around the logo
To make this one work, you need to add this keys to our .env file :
```bash
GITHUB_REPOSITORY=user/name-of-the-repo
GITHUB_TOKEN= # Recommended but not compulsory for all repos, required for private repos
GITHUB_CACHE_TTL= # in seconds, 3600 by default
```
If needed, you can generate a token [here](https://github.com/settings/personal-access-tokens). 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 :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withLoadTime(),
])
```
You can also display a prefix by using this configuration :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withLoadTime('This page loaded in'),
])
```
### 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:
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withLogo(
'https://static.cdnlogo.com/logos/l/23/laravel.svg', // Path to logo
'https://laravel.com' // URL for logo link (optional)
)
])
```
You can customize the logo further with optional text and height:
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withLogo(
'https://static.cdnlogo.com/logos/l/23/laravel.svg', // Path to logo
'https://laravel.com', // URL for logo link (optional)
'Powered by Laravel', // Text to display (optional)
35 // Logo height in pixels (default: 20)
)
])
```
If you don't need the link, you can pass `null` for the second parameter:
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withLogo(
'https://static.cdnlogo.com/logos/l/23/laravel.svg', // Path to logo
null, // No link
null, // No text
60 // Logo height in pixels
)
])
```
### Links
You can add **custom links** (3 links max) to the footer by using this configuration :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withLinks([
['title' => 'About', 'url' => 'https://example.com/about'],
['title' => 'CGV', 'url' => 'https://example.com/cgv'],
['title' => 'Privacy Policy', 'url' => 'https://example.com/privacy-policy']
]),
])
````
### Border on top
You can add a border on the top of the footer by using this configuration :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->withBorder(),
])
```
### 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 :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->hiddenFromPagesEnabled(),
])
```
If you would like to hide the footer on other pages, you can use this configuration :
```php
use Devonab\FilamentEasyFooter\EasyFooterPlugin;
->plugins([
EasyFooterPlugin::make()
->hiddenFromPagesEnabled()
->hiddenFromPages(['sample-page', 'another-page', 'admin/login', 'admin/forgot-password', 'admin/register']),
])
```
Note that anything set in `hiddenFromPages()` will override the default behavior.
## Testing
---
You can run the test with this command
```bash
composer test
```
## Changelog
---
Please see [CHANGELOG](https://github.com/Devonab/filament-easy-footer/releases) for more information on what has changed recently.
## Contributing
---
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
---
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
---
- [Devonab](https://github.com/Devonab)
- [All Contributors](../../contributors)
## License
---
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.