Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mckenziearts/laravel-notify
Flexible Flash notifications for Laravel
https://github.com/mckenziearts/laravel-notify
flash-messages laravel laravel-package notifications toast
Last synced: 3 days ago
JSON representation
Flexible Flash notifications for Laravel
- Host: GitHub
- URL: https://github.com/mckenziearts/laravel-notify
- Owner: mckenziearts
- License: other
- Created: 2019-10-26T19:26:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-25T07:48:43.000Z (4 months ago)
- Last Synced: 2024-09-25T22:44:40.685Z (8 days ago)
- Topics: flash-messages, laravel, laravel-package, notifications, toast
- Language: Blade
- Homepage:
- Size: 2.16 MB
- Stars: 1,609
- Watchers: 33
- Forks: 188
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
## Introduction
Laravel Notify is a package that lets you add custom notifications to your project.
A diverse range of notification design is available.
## Android Version
If you need Android version please try this package [Aesthetic Dialogs](https://github.com/gabriel-TheCode/AestheticDialogs). Happy Coding 👨🏾💻
## :film_strip: Video Tutorial
[
](https://youtu.be/Kq5VXLex7DU)
## Installation
You can install the package using composer
```sh
$ composer require mckenziearts/laravel-notify
```
Then add the service provider to `config/app.php`. In Laravel versions 5.5 and beyond, this step can be skipped if package auto-discovery is enabled.
```php
'providers' => [
...
Mckenziearts\Notify\LaravelNotifyServiceProvider::class
...
];
```
You can publish the configuration file and assets by running:
```sh
$ php artisan vendor:publish --provider="Mckenziearts\Notify\LaravelNotifyServiceProvider"
```
Now that we have published a few new files to our application we need to reload them with the following command:
```sh
$ composer dump-autoload
```
## Usage
1. Add styles links with `@notifyCss`
2. Add scripts links with `@notifyJs`
3. use `notify()` helper function inside your controller to set a toast notification for info, success, warning or error
4. Include notify partial to your master layout `@include('notify::components.notify')`
If you are on Laravel 8 or greater, you can use the tag syntax.
```html
```
### Basic
Within your controllers, before you perform a redirect call the `notify` method with a message.
```php
public function store()
{
notify()->success('Laravel Notify is awesome!');
return Redirect::home();
}
```
A complete example:
```blade
Laravel Notify
@notifyCss
@notifyJs
```
### Type of notifications
Laravel Notify actually display 5 types of notifications
1. `toast` notification, (The default notification for Laravel Notify)
```php
notify()->success('Welcome to Laravel Notify ⚡️') or notify()->success('Welcome to Laravel Notify ⚡️', 'My custom title')
```
2. `connectify` notification, example of basic usage
```php
connectify('success', 'Connection Found', 'Success Message Here')
```
3. `drakify` (😎) notification, displays an alert only
```php
drakify('success') // for success alert
or
drakify('error') // for error alert
```
4. `smilify` notification, displays a simple custom toast notification using the smiley (😊) emoticon
```php
smilify('success', 'You are successfully reconnected')
```
5. `emotify` notification, displays a simple custom toast notification using a vector emoticon
```php
emotify('success', 'You are awesome, your data was successfully created')
```
#### Preset Notifications
If you have a specific notification that is used across multiple different places in your system, you can define it
as a preset notification in your config file. This makes it easier to maintain commonly used notifications in one place.
Read how to define preset messages in the [Config](#config) section below.
As an example, to use a preset notification you have defined called 'common-notification', use the following:
```php
notify()->preset('common-notification')
```
You can override any of the values that are set in the config if you need to. For example, this could be useful if you
have a common notification across, but you want to change the icon in one particular place that it's used without having
to manually write out a new notification.
To do this, simply pass in an array that has the key of the attribute that you want to override and the value you want
to override it with.
As an example, we could override the 'title' of our 'common-notification' by using the following:
```php
notify()->preset('common-notification', ['title' => 'This is the overridden title'])
```
## Config
Config file are located at `config/notify.php` after publishing provider element.
Some awesome stuff. To active `dark mode` update the `theme` config, or add global variable `NOTIFY_THEME` on your .env file
```php
'theme' => env('NOTIFY_THEME', 'dark'),
```
You can define preset notifications in the config file using the following structure:
```php
'preset-messages' => [
'user-updated' => [
'message' => 'The user has been updated successfully.',
'type' => 'success',
'model' => 'connect',
'title' => 'User Updated',
],
'user-deleted' => [
'message' => 'The user has been deleted successfully.',
'type' => 'success',
'model' => 'connect',
'title' => 'User Deleted',
],
],
```
The example above shows the config for two preset notifications: 'user-updated' and 'user-deleted'.
## Change log
Please see the [changelog](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [contributing.md](CONTRIBUTING.md) for details and a todolist.
## Security
If you discover any security related issues, please email author email instead of using the issue tracker.
## Credits
- [Arthur Monney][link-author]
- [All Contributors][link-contributors]
## License
license. Please see the [license file](LICENCE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/mckenziearts/laravel-notify.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/mckenziearts/laravel-notify.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/mckenziearts/laravel-notify
[link-downloads]: https://packagist.org/packages/mckenziearts/laravel-notify
[link-author]: https://twitter.com/MonneyArthur
[link-contributors]: ../../contributors