https://github.com/helmesvs/laravel-notify

Elegant notifications to laravel with Toastr or PNotify
https://github.com/helmesvs/laravel-notify

laravel notifications php pnotify toastr

Last synced: 28 days ago
JSON representation

Elegant notifications to laravel with Toastr or PNotify

• Host: GitHub
• URL: https://github.com/helmesvs/laravel-notify
• Owner: Helmesvs
• License: mit
• Created: 2017-09-28T19:35:33.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-11-20T22:26:34.000Z (almost 5 years ago)
• Last Synced: 2024-10-11T11:41:11.570Z (28 days ago)
• Topics: laravel, notifications, php, pnotify, toastr
• Language: CSS
• Homepage:
• Size: 114 KB
• Stars: 63
• Watchers: 7
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Laravel Notify

======

Elegant notifications to laravel with [Toastr](https://github.com/CodeSeven/toastr) or [PNotify](https://github.com/sciactive/pnotify)

![alt text](https://i.imgur.com/Tt1L6Bt.png)

Installation

------------

1. Either run `composer require helmesvs/laravel-notify` or add `"helmesvs/laravel-notify"` to the `require` key in `composer.json` and run `composer install`.

2. Add `Helmesvs\Notify\NotifyServiceProvider::class,` to the `providers` key in `config/app.php`.

3. Add `'Notify' => Helmesvs\Notify\Facades\Notify::class,` to the `aliases` key in `config/app.php`.

4. Run `php artisan vendor:publish --provider="Helmesvs\Notify\NotifyServiceProvider" --tag="notify"` to publish the config file.

5. Include the output `{!! Notify::render() !!}` in your master view template.

6. *Optional*: Modify the configuration file located in config/notify.php.

Usage

-----

Call one of these methods in your controllers to insert a notification:

  - `Notify::warning($message, $title = null, $options = [])` - add a warning notification

  - `Notify::error($message, $title = null, $options = [])` - add an error notification

  - `Notify::info($message, $title = null, $options = [])` - add an info notification

  - `Notify::success($message, $title = null, $options = [])` - add a success notification

  - `Notify::add($type: warning|error|info|success, $message, $title = null, $options = [])` - add a notification

  - **`Notify::clear()` - clear all current notification**

Configuration

-------------

Open `config/notify.php` to adjust package configuration. If this file doesn't exist, run `php artisan vendor:publish --provider="Helmesvs\Notify\NotifyServiceProvider" --tag="notify"` to create the default configuration file.

### General Options 

``` php

'options' => [

        'lib' => 'toastr',

        'style' => 'custom'

]

```

Set `'lib'` as `toastr` to use [toastr.js](https://github.com/CodeSeven/toastr) or `pnotify` to use [pnotify.js](https://github.com/sciactive/pnotify).

Set `'style'` to `'custom'` to use custom settings, or as `'default'` to default library settings.

The style of notifications can be customized in `public/vendor/Notify/style.css`.

### Options Toastr

``` php

'ToastrOptions' => [

        "closeButton" => false,

        "closeHtml" => '',

        "newestOnTop" => true,

        "progressBar" => false,

        ...

]

```

### Options PNotify

``` php

'PNotifyOptions' => [

        'title_escape' => false,

        'text_escape' => false,

        'styling' => 'brighttheme',

        'addclass' => '', 

        ...

]

```

For a list of available options, see [toastr.js' documentation](https://github.com/CodeSeven/toastr) and [pnotify.js' documentation](https://github.com/sciactive/pnotify).