ryangjchandler / filament-profile
A simple profile page for Filament.
Fund package maintenance!
ryangjchandler
Installs: 38 855
Dependents: 1
Suggesters: 0
Security: 0
Stars: 99
Watchers: 2
Forks: 14
Open Issues: 3
Requires
- php: ^8.0
- filament/filament: ^2.0
- illuminate/contracts: ^9.0|^10.0
- spatie/laravel-package-tools: ^1.11
Requires (Dev)
- nunomaduro/collision: ^6.0|^7.0
- nunomaduro/larastan: ^2.0
- orchestra/testbench: ^7.0|^8.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5|^10.0
- spatie/laravel-ray: ^1.26
README
Warning
With the release of Filament v3, this package is no being maintained or updated. Filament now includes a Profile page out of the box and we recommend using that instead.
This package provides a very simple Profile
page that allows the current user to manage their name, email address and password inside of Filament.
Installation
You can install the package via Composer:
composer require ryangjchandler/filament-profile
Optionally, you can publish the views using
php artisan vendor:publish --tag="filament-profile-views"
Usage
This package will automatically register the Profile
page as a Livewire component, but won't automatically add it to Filament. You should add the following line of code to your config/filament.php
file.
'pages' => [ // ... 'register' => [ // ... \RyanChandler\FilamentProfile\Pages\Profile::class ], ],
If you visit your Filament panel now, you'll see a new Account
navigation group as well as a Profile
page.
Customising the Profile
page
Since the package does not automatically add the Profile
page to your Filament panel, you are free to extend the page and customise it yourself.
You should first run the following command in your terminal:
php artisan filament:page Profile
This will create a new App\Filament\Pages\Profile
class in your project.
You can then update this class to extend the RyanChandler\FilamentProfile\Pages\Profile
class.
namespace App\Filament\Pages; use RyanChandler\FilamentProfile\Pages\Profile as BaseProfile; class Profile extends BaseProfile { // ... }
Filament will automatically register your new Profile
page and you're able to customise it to your liking. You can remove the navigation group, modify the form, etc.
Testing
composer test
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.