Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laracasts/flash
Easy flash notifications
https://github.com/laracasts/flash
Last synced: 30 days ago
JSON representation
Easy flash notifications
- Host: GitHub
- URL: https://github.com/laracasts/flash
- Owner: laracasts
- Created: 2014-06-30T04:03:54.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-03T16:52:09.000Z (9 months ago)
- Last Synced: 2024-09-30T17:20:59.152Z (about 1 month ago)
- Language: PHP
- Homepage: https://packagist.org/packages/laracasts/flash
- Size: 73.2 KB
- Stars: 2,650
- Watchers: 73
- Forks: 365
- Open Issues: 40
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Easy Flash Messages for Your Laravel App
This composer package offers a Twitter Bootstrap optimized flash messaging setup for your Laravel applications.
## Installation
Begin by pulling in the package through Composer.
```bash
composer require laracasts/flash
```
Next, as noted above, the default CSS classes for your flash message are optimized for Twitter Bootstrap. As such, either pull in the Bootstrap's CSS within your HTML or layout file, or write your own CSS based on these classes.
```html
```
## Usage
Within your controllers, before you perform a redirect, make a call to the `flash()` function.
```php
public function store()
{
flash('Welcome Aboard!');
return home();
}
```
You may also do:
- `flash('Message')->success()`: Set the flash theme to "success".
- `flash('Message')->error()`: Set the flash theme to "danger".
- `flash('Message')->warning()`: Set the flash theme to "warning".
- `flash('Message')->overlay()`: Render the message as an overlay.
- `flash()->overlay('Modal Message', 'Modal Title')`: Display a modal overlay with a title.
- `flash('Message')->important()`: Add a close button to the flash message.
- `flash('Message')->error()->important()`: Render a "danger" flash message that must be dismissed.
With this message flashed to the session, you may now display it in your view(s). Because flash messages and overlays are so common, we provide a template out of the box to get you started. You're free to use - and even modify to your needs - this template how you see fit.
```html
@include('flash::message')
```
## Example
```html
Document
@include('flash::message')
Welcome to my website...
$('#flash-overlay-modal').modal();
```
If you need to modify the flash message partials, you can run:
```bash
php artisan vendor:publish --provider="Laracasts\Flash\FlashServiceProvider"
```
The two package views will now be located in the `resources/views/vendor/flash/` directory.
```php
flash('Welcome Aboard!');
return home();
```
```php
flash('Sorry! Please try again.')->error();
return home();
```
```php
flash()->overlay('You are now a Laracasts member!', 'Yay');
return home();
```
> [Learn exactly how to build this very package on Laracasts!](https://laracasts.com/lessons/flexible-flash-messages)
## Hiding Flash Messages
A common desire is to display a flash message for a few seconds, and then hide it. To handle this, write a simple bit of JavaScript. For example, using jQuery, you might add the following snippet just before the closing `