https://github.com/coderatio/laranotify
A feature-rich laravel package that turns bootstrap notify jQuery plugin to dynamic notifications, alerts and blockables.
https://github.com/coderatio/laranotify
Last synced: 11 months ago
JSON representation
A feature-rich laravel package that turns bootstrap notify jQuery plugin to dynamic notifications, alerts and blockables.
- Host: GitHub
- URL: https://github.com/coderatio/laranotify
- Owner: coderatio
- License: mit
- Created: 2018-03-02T10:51:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-10T14:55:52.000Z (about 8 years ago)
- Last Synced: 2025-06-03T08:44:43.290Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 3.41 MB
- Stars: 9
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laranotify
The most advanced laravel package to dynamically display beautiful and elegant alert messages, blockables and notifications on screen. This is built with fluency in mind--meaning, you can chain as many methods as you want. Lots of functionalities are available. See demos
It's built on top of Bootstrap notify or growl plugin. It comes with all methods in the plugin with lots of additional advanced methods. It therefore, requires you to have bootstrap installed on your project. However, customizing the template, gives your users different looks. Read about template customization under templates section.
> **Note:** _To start building your custom template, it's advisable to publish a sample to your view directory. When published, the sample template will be copied to laranotify directory inside your views folder. Learn about template publishing here_.
# Installation
Laranotify installation should be done via composer.
Require `coderatio/laranotify` in your project's composer.json file OR
Do `composer require coderatio/laranotify` on your terminal or command prompt if you are on Windows OS.
# Provider and Aliases
If your Laravel installed version is less than 5.5, you will need to manually register the service provider and aliases. The provider and aliases are auto-discovered in version 5.5 and above.
To register the package service provider and aliases, open your `app.php` in config directory of your laravel installation then copy and paste:
```php
// Laranotify provider
Coderatio\Laranotify\LaranotifyServiceProvider::class,
```
Under your providers array.
Then in your aliases array, copy and paste:
```php
// Laranotify aliases
'Notify' => Coderatio\Laranotify\Facades\Notify::class,
'Laranotify' => Coderatio\Laranotify\Facades\Laranotify::class,
```
The aliases are Facades that helps you bind non static methods as static to the package service class. E.g
```php
Notify::success('This is a message');
```
# Publishing
The package has configuration and assets files that needs to be published to your app public directory. To publish these files, run;
```vim
php artisan vendor:publish --tag=laranotify-required
```
on your command line.
# Header and footer
Finally, call ``notify_header()`` function at the head tag and `notify_footer()` after your bootstrap JavaScript file to register laranotify assets in your project. This step is required.
e.g
##### Header
```html
{{ notify_header() }}
```
> **Note:** _If you want to use the included Bootstrap css file, pass ``true`` as a parameter to the function like this:_
```blade
{{ notify_header(true) }}
```
##### Footer
```html
{{ notify_footer() }}