Download the PHP package diogogpinto/filament-auth-ui-enhancer without Composer
On this page you can find all versions of the php package diogogpinto/filament-auth-ui-enhancer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download diogogpinto/filament-auth-ui-enhancer
More information about diogogpinto/filament-auth-ui-enhancer
Files in diogogpinto/filament-auth-ui-enhancer
Package filament-auth-ui-enhancer
Short Description This Filament plugin empowers you to transform your auth pages with ease, allowing you to make them truly stand out. It offers a flexible alternative to the default auth pages in the Filament Panels package.
License MIT
Homepage https://github.com/diogogpinto/filament-auth-ui-enhancer
Informations about the package filament-auth-ui-enhancer
Auth UI Enhancer for Filament Panels 🔥
Looking for an easy way to customize the UI of your Auth Pages in your Filament Panel?
This Filament plugin empowers you to transform your auth pages with ease, allowing you to make them truly stand out. It offers a flexible alternative to the default auth pages in the Filament Panels package.
Setting it up is a breeze, and it comes packed with a variety of customizable features—plus, there’s a lot more to come! 🔥
Check out some examples you can create right out of the box:
Navigation
- Installation
- Usage
- AuthPage Discovery
- Customizing the Auth UI
- Customizing the Form Panel
- Customizing the Empty Panel
- Further Customization - CSS
- Working Examples
- Todo
- Changelog
- Contributing
- Security Vulnerabilities
- Credits
- License
Installation
First, starting by installing the plugin via composer:
In an effort to align with Filament's theming methodology you will need to use a custom theme to use this plugin.
[!IMPORTANT] If you have not set up a custom theme, follow the instructions in the Filament Docs first.
- Add the plugin's views to your
tailwind.config.js
file. (path: /resource/css/filament/admin)
[!IMPORTANT] The above content should be placed in your filament theme's
tailwind.config.js
file, under the /resources/css/filament path
- Run
npm run build
in your terminal
Usage
To start using the plugin, you need to add the plugin to your plugins array in your filament panel.
Auth Page Discovery
Default Auth Logic
If you don't have any custom classes on the auth methods of your Filament panel (login(), registration(), resetPassword() and emailVerification()), this plugin will work almost out of the box.
If your panel provider is setup like below, this plugin will automatically apply the changes to your UI.
Custom Auth Logic
If you have custom logic in the mentioned methods, there is a simple way to make that UI pop, using a simple trait from this plugin. If your panel looks like the below:
Just add the following trait to YouLoginClass
:
Customizing the Auth UI
The view for this package divides your screen in two sections:
- Form Panel - The panel that contains the form
- Empty Panel - The panel that contains the image
Customizing the Form Panel
You can customize:
- The form panel position in both desktop and mobile
- The form panel width in desktop
- The form panel background color
Form Position
You can make the form appear on the left side of the page or in the right side of the page.
`
Form Position on Mobile
On mobile devices, you can chose if the form appears above the empty container or below.
This method accepts top
or bottom
as arguments. You can also hide the empty panel on mobile (see below).
Form Panel Width
The form panel width has a default value of 50%
. You can change it by adding the following method and passing the desired width.
Sizes must be expressed in rem, %, px, em, vw, vh or pt.
Form Panel Background Color
You can change the form panel background color by using the following method:
In this case, 300 is the shade of the color you want to use.
You can also set the color using HEX or RGB, like in a typical filament panel:
Customizing the Empty Panel
You can customize:
- The empty panel background color
- The empty panel background image and its opacity
- Either to show or hide empty panel on mobile
Empty Panel Background Image and Image Opacity
You can set an image to be displayed on the empty panel, and control its opacity.
You can pass an asset url, with Laravel's function asset('images/login.webp')
.
If you would like to chance the image opacity of your image, you can use the following method:
Empty Panel Background Color
The default background color is your panel's primary color. You can change the empty panel background color by using the following method:
In this case, 300 is the shade of the color you want to use.
You can also set the color using HEX or RGB, like in a typical filament panel:
Hide Empty Panel on Mobile Devices
You can just use the following method, so the empty panels disappears on mobile and the form container spans to full height:
Further Customization - CSS
You can create further customizations in your theme's CSS file. The following classes are avaliable:
Working Example
If you're just looking to plug and play some code into your Filament Panel, here's a working code so you can just insert into your plugins array:
[!WARNING]
This is a random image URL I got from Pexels. If you want to use it in production or commercially you should check its license.
Todo
- Render custom views on empty panel
- Develop different layouts
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
- Diogo Pinto - you can follow me on Twitter
- Joao Patrício for his amazing support
- CodeWithDennis for his early contributions
- Geridoc for allowing me to release our packages with Open Source licenses
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of filament-auth-ui-enhancer with dependencies
filament/filament Version ^3.0
spatie/laravel-package-tools Version ^1.15.0