Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryangjchandler/filament-profile
A simple profile management page for Filament. ✨
https://github.com/ryangjchandler/filament-profile
Last synced: about 1 month ago
JSON representation
A simple profile management page for Filament. ✨
- Host: GitHub
- URL: https://github.com/ryangjchandler/filament-profile
- Owner: ryangjchandler
- License: mit
- Archived: true
- Created: 2022-01-16T18:06:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-03T09:25:12.000Z (11 months ago)
- Last Synced: 2024-01-10T18:26:34.923Z (5 months ago)
- Language: PHP
- Size: 172 KB
- Stars: 100
- Watchers: 2
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Lists
- awesome-filament - ryangjchandler/filament-profile - A simple profile management page for Filament. (MISC)
README
# A simple profile page for Filament.
> **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.
[](https://packagist.org/packages/ryangjchandler/filament-profile)
[](https://github.com/ryangjchandler/filament-profile/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/ryangjchandler/filament-profile/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/ryangjchandler/filament-profile)
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:
```bash
composer require ryangjchandler/filament-profile
```
Optionally, you can publish the views using
```bash
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.
```php
'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:
```bash
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.
```php
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
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) 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
- [Ryan Chandler](https://github.com/ryangjchandler)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.