Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jantinnerezo/livewire-alert
SweetAlert2 wrapper for Livewire
https://github.com/jantinnerezo/livewire-alert
laravel livewire sweetalert2
Last synced: about 2 months ago
JSON representation
SweetAlert2 wrapper for Livewire
- Host: GitHub
- URL: https://github.com/jantinnerezo/livewire-alert
- Owner: jantinnerezo
- License: mit
- Created: 2020-06-14T04:12:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-27T16:07:09.000Z (5 months ago)
- Last Synced: 2024-07-27T17:54:33.095Z (about 2 months ago)
- Topics: laravel, livewire, sweetalert2
- Language: PHP
- Homepage: https://livewire-alert.jantinnerezo.com
- Size: 11.4 MB
- Stars: 687
- Watchers: 12
- Forks: 73
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Livewire Alert
Livewire Alert is a simple alert utility package designed to seamlessly integrate with your Livewire components. Under the hood, it utilizes SweetAlert2, offering you the functionality of SweetAlert2 without the need for any custom Javascript.
## Interactive Demo
Check the interactive demo here: https://livewire-alert.jantinnerezo.com
## Contribute to interactive demo
Do you have any ideas in mind that you can add to the interactive demo? Fork and submit a PR here: https://github.com/jantinnerezo/livewire-alert-demo
## Installation
You can install the package via composer:
```bash
composer require jantinnerezo/livewire-alert
```
Next, add the scripts component to your template after the `@livewireScripts`.
> SweetAlert2 script is not included by default so make sure you include it before livewire alert script.
``` html
@livewireScripts
```
You can also manually include the script by publishing `livewire-alert.js`
``` bash
php artisan vendor:publish --tag=livewire-alert:assets
```
And then in your view you can include the published script instead of including inline script with `` component.
> If you go this path, make sure to include the `` right after the livewire-alert script if you still want the flash feature.
``` html
```
## Requirements
This package is meant to use with Livewire components. Make sure you are using it with Livewire projects only.
- PHP 8.1 or higher
- Laravel 7, 8, 9 and 10
- Livewire
- SweetAlert2
## Usage
You can use livewire alert by using the `LivewireAlert` trait.
``` php
use Jantinnerezo\LivewireAlert\LivewireAlert;
class Index extends Component
{
use LivewireAlert;
public function submit()
{
$this->alert('success', 'Basic Alert');
}
}
```
Displaying different alert icons.
> The default alert behaviour is a toast notification.
``` php
$this->alert('success', 'Success is approaching!');
```
``` php
$this->alert('warning', 'The world has warned you.');
```
``` php
$this->alert('info', 'The fact is you know your name :D');
```
``` php
$this->alert('question', 'How are you today?');
```
Disabling toast notification alert treatment.
``` php
$this->alert('info', 'This is not as toast alert', [
'toast' => false
]);
```
## Positioning Alert
``` php
$this->alert('info', 'Centering alert', [
'position' => 'center'
]);
```
List of the following alert positions:
- top
- top-start
- top-end
- center
- center-start
- center-end
- bottom
- bottom-start
- bottom-end
## Buttons
SweetAlert2 has 3 buttons that is not shown by default.
To show confirm button, simply pass the `showConfirmButton` to alert configuration and set it to `true`.
``` php
$this->alert('question', 'How are you today?', [
'showConfirmButton' => true
]);
```
Change confirm button text:
``` php
$this->alert('question', 'How are you today?', [
'showConfirmButton' => true,
'confirmButtonText' => 'Good'
]);
```
Adding event when confirm button is clicked. First create a function that will be fired when confirm button is clicked:
``` php
public function confirmed()
{
// Do something
}
```
Add to it event listeners array to register it.
``` php
protected $listeners = [
'confirmed'
];
```
Or
``` php
public function getListeners()
{
return [
'confirmed'
];
}
```
And then pass it to `onConfirmed` key of the alert configuration.
``` php
$this->alert('question', 'How are you today?', [
'showConfirmButton' => true,
'confirmButtonText' => 'Good',
'onConfirmed' => 'confirmed'
]);
```
You can also pass a parameter to the event to get the alert response.
> Useful when you need to get the value of the input inside the alert.
``` php
$this->alert('warning', 'Please enter password', [
'showConfirmButton' => true,
'confirmButtonText' => 'Submit',
'onConfirmed' => 'confirmed',
'input' => 'password',
'inputValidator' => '(value) => new Promise((resolve) => '.
' resolve('.
' /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[#$^+=!*()@%&]).{8,}$/.test(value) ?'.
' undefined : "Error in password"'.
' )'.
')',
'allowOutsideClick' => false,
'timer' => null
]);
```
``` php
public function confirmed($data)
{
// Get input value and do anything you want to it
$password = $data['value'];
}
```
Just do the same thing to show `deny` and `cancel` button. Just create a function for each button and register it to event listeners.
``` php
public function denied()
{
// Do something when denied button is clicked
}
```
``` php
public function cancelled()
{
// Do something when cancel button is clicked
}
```
``` php
public function getListeners()
{
return [
'denied',
'dismissed'
];
}
```
Make sure to set `showDenyButton` and `showCancelButton` to `true`.
``` php
$this->alert('warning', 'Alert with deny and cancel button', [
'showDenyButton' => true,
'denyButtonText' => 'Deny',
'showCancelButton' => true,
'cancelButtonText' => 'Cancel',
'onDenied' => 'denied',
'onDismissed' => 'cancelled'
]);
```
Emit events to only specific component. Instead of passing the listener directly to the event, pass an array with `component` and `listeners` keys.
``` PHP
'onConfirmed' => [
'component' => 'livewire-component',
'listener' => 'confirmed'
];
```
Don't want to define extra button configuration every time you show alert confirmation? Use the confirm method instead.
> You can always override default confirm settings just tweak the configuration.
``` php
$this->confirm('Are you sure do want to leave?', [
'onConfirmed' => 'confirmed',
]);
```
## Flash Notification
You can also use alert as a flash notification. You can pass the redirect route on the fourth parameter, redirects to `/` by default.
``` php
$this->flash('success', 'Successfully submitted form', [], '/');
```
## Configuration
Override default alert config by publishing the `livewire-alert.php` config file.
``` bash
php artisan vendor:publish --tag=livewire-alert:config
```
``` php
[
'alert' => [
'position' => 'top-end',
'timer' => 3000,
'toast' => true,
'text' => null,
'showCancelButton' => false,
'showConfirmButton' => false
],
'confirm' => [
'icon' => 'warning',
'position' => 'center',
'toast' => false,
'timer' => null,
'showConfirmButton' => true,
'showCancelButton' => true,
'cancelButtonText' => 'No',
'confirmButtonColor' => '#3085d6',
'cancelButtonColor' => '#d33'
]
]
```
## Customizations
You can customize alert style by passing your custom classes, works perfectly with [TailwindCSS](https://tailwindcss.com/)
``` php
[
'customClass' => [
'container' => '',
'popup' => '',
'header' => '',
'title' => '',
'closeButton' => '',
'icon' => '',
'image' => '',
'content' => '',
'htmlContainer' => '',
'input' => '',
'inputLabel' => '',
'validationMessage' => '',
'actions' => '',
'confirmButton' => '',
'denyButton' => '',
'cancelButton' => '',
'loader' => '',
'footer' => ''
]
];
```
For more details about customization and configuration please check [SweetAlert2](https://sweetalert2.github.io/#configuration/)
## Contributors
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.