Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codewithdennis/filament-simple-alert
This package offers a straightforward and easy-to-use alert component for your Filament application. It allows you to quickly implement customizable alert messages, enhancing the user experience by providing clear and concise notifications.
https://github.com/codewithdennis/filament-simple-alert
alert alerts filament filament-plugin filamentphp filamentphp-plugin laravel livewire package php plugin
Last synced: 3 days ago
JSON representation
This package offers a straightforward and easy-to-use alert component for your Filament application. It allows you to quickly implement customizable alert messages, enhancing the user experience by providing clear and concise notifications.
- Host: GitHub
- URL: https://github.com/codewithdennis/filament-simple-alert
- Owner: CodeWithDennis
- License: mit
- Created: 2024-06-27T07:36:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-20T12:18:02.000Z (13 days ago)
- Last Synced: 2024-09-21T12:37:10.603Z (12 days ago)
- Topics: alert, alerts, filament, filament-plugin, filamentphp, filamentphp-plugin, laravel, livewire, package, php, plugin
- Language: PHP
- Homepage:
- Size: 1.16 MB
- Stars: 29
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Filament Simple Alert
[](https://packagist.org/packages/codewithdennis/filament-simple-alert)
[](https://github.com/codewithdennis/filament-simple-alert/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
[](https://packagist.org/packages/codewithdennis/filament-simple-alert)
This package offers a straightforward and easy-to-use alert component for your Filament application. It allows you to quickly implement customizable alert messages, enhancing the user experience by
providing clear and concise notifications.
## Installation
You can install the package via composer:
```bash
composer require codewithdennis/filament-simple-alert
```
Make sure you add the following to your `tailwind.config.js file.
```bash
'./vendor/codewithdennis/filament-simple-alert/resources/**/*.blade.php',
```
### Installing on a project with Tailwind already set up?
If you have installed filament into an existing project with Tailwind as part of it then you will need to [publish a custom theme](https://filamentphp.com/docs/3.x/panels/themes#creating-a-custom-theme for the styles to be applied correctly.
## Usage
The alerts can be used in your `infolists` or `forms`, make sure you pick the right component.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
```
```php
use CodeWithDennis\SimpleAlert\Components\Forms\SimpleAlert;
```
### Simple Alerts
There are 4 types of simple alerts: `danger`, `info`, `success`, and `warning`.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->danger()
->info()
->success()
->warning()
```
If you would like to use a [different color](https://filamentphp.com/docs/3.x/support/colors), you can use the `color` method.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->color('purple')
```
### Icon
By default, all simple alerts will have an icon. If you would like to change the icon, you can use the `icon` method.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->color('purple')
->icon('heroicon-s-users')
```
### Title
You can add a title to the alert by using the `title` method.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->title('Hoorraayy! Your request has been approved! 🎉')
```
### Description
You can add a description to the alert by using the `description` method.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->description('This is the description')
```
### Link
You can also add a link to the alert by using the `link` method.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->info()
->link('https://filamentphp.com'),
```
If you would like to customize the link label, you can use the `linkLabel` method.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->info()
->link('https://filamentphp.com')
->linkLabel('Read more!'),
```
If you would like the link to open in a new tab, you can use the `linkBlank` method.
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->info()
->link('https://filamentphp.com')
->linkBlank(),
```
### Example
```php
use CodeWithDennis\SimpleAlert\Components\Infolists\SimpleAlert;
SimpleAlert::make()
->success()
->title(new HtmlString('Hoorraayy! Your request has been approved! 🎉'))
->description('Lorem ipsum dolor sit amet consectetur adipisicing elit.')
->link('https://filamentphp.com')
->linkLabel('Read more!')
->linkBlank(),
```
### Screenshots
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Credits
- [CodeWithDennis](https://github.com/CodeWithDennis)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.