Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smodav/flash
This is a laravel package for displaying flash notifications that extends Sweet Alert and provides an extra custom notice notification on the top left.
https://github.com/smodav/flash
Last synced: 2 months ago
JSON representation
This is a laravel package for displaying flash notifications that extends Sweet Alert and provides an extra custom notice notification on the top left.
- Host: GitHub
- URL: https://github.com/smodav/flash
- Owner: SmoDav
- License: mit
- Created: 2016-06-15T13:34:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-07-26T11:44:14.000Z (over 8 years ago)
- Last Synced: 2024-04-02T02:41:26.982Z (9 months ago)
- Language: CSS
- Homepage:
- Size: 63.5 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flash Notifier
[](https://travis-ci.org/SmoDav/flash)
[](https://packagist.org/packages/smodav/flash)
[](https://packagist.org/packages/smodav/flash)
[](https://packagist.org/packages/smodav/flash)
[](https://packagist.org/packages/smodav/flash)
This is a laravel package for displaying flash notifications that extends [Sweet Alert](http://t4t5.github.io/sweetalert/) and provides an extra custom notice notification on the top left.
## Installation
Pull in the package through Composer.
Run `composer require smodav/flash`
When using Laravel 5, include the service provider and its alias within your `config/app.php`.
```php
'providers' => [
SmoDav\Flash\FlashServiceProvider::class,
];
'aliases' => [
'Flash' => SmoDav\Flash\Flash::class,
];
```
Publish the package specific assets and view using
```bash
php artisan vendor:publish
```
This will publish the flash view into `resources/views/vendor/smodav/flash/` directory and also its accompanying css and javascript files into their respective `resources/assets/` directory.
## Usage
The package comes with a helper function `flash()` and its respective facade `Flash`. Within your controllers or closures, use either before a redirect:
```php
public function delete()
{
flash()->success('Users', 'Successfully banned user.');
return redirect()->route('users.index');
}
// OR
public function delete()
{
Flash::success('Users', 'Successfully banned user.');
return redirect()->route('users.index');
}
```
If you would like the notification to persist till dismissed by the user, use the `persist()` method on the instance:
```php
public function delete()
{
Flash::success('Users', 'Successfully banned user.')->persist();
return redirect()->route('users.index');
}
```
The package has allows you to send different types of flash alerts:
- `Flash::info('Title', 'Message')`
- `Flash::success('Title', 'Message')`
- `Flash::error('Title', 'Message')`
- `Flash::warning('Title', 'Message')`
All the above can be persisted using `persist()`.
An additional `notice()` is included that provides a notice on the top right edge, however, the notice cannot be persisted:
- `Flash::notice('Message')`
```php
public function delete()
{
Flash::notice('Successfully banned user.');
return redirect()->route('users.index');
}
```
For a basic flash instance of type info, just use the flash helper function:
`flash(Title, Message)`
When using Laravel, this package creates flash session keys:
**Alerts**
- `sf_title` containing the title of the flash message.
- `sf_message` containing the actual flash message.
- `sf_level` containing the level of flash message.
- `sf_persist` only present when persist is used.
**Notices**
- `sf_notice_message` containing the flash notice message.
Within your views, include the `flash` view and the corresponding css and javascript files. You may modify the flash view and add more functionality to the flash instances by passing the properties described in [Sweet Alert](http://t4t5.github.io/sweetalert/) to the `sflash` instance:
```
sflash({
title: "{{ session('sf_title') }}",
text: "{{ session('sf_message') }}",
type: "{{ session('sf_level') }}",
allowOutsideClick: true,
confirmButtonText: "Okay Man",
showConfirmButton: true
});
```