Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hakanersu/amaran-laravel
AmaranJS stylish notification for your laravel application.
https://github.com/hakanersu/amaran-laravel
jquery laravel notification
Last synced: about 2 months ago
JSON representation
AmaranJS stylish notification for your laravel application.
- Host: GitHub
- URL: https://github.com/hakanersu/amaran-laravel
- Owner: hakanersu
- License: mit
- Created: 2015-01-22T08:12:19.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-06-17T11:02:55.000Z (over 7 years ago)
- Last Synced: 2024-08-01T06:20:46.187Z (5 months ago)
- Topics: jquery, laravel, notification
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 23
- Watchers: 5
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AmaranJS Laravel 5 Package
==========================
[](http://laravel.com)
[](https://github.com/hakanersu/amaran-laravel)
[](https://tldrlegal.com/license/mit-license)
[AmaranJS][1] L5 package is a Laravel wrapper for my jquery plugin [AmaranJS][1].You can create easy and stylish notifications with [AmaranJS][1].
Package Demo: http://ersu.me/laravel-amaranjs
Installation
------------
Begin by installing the package through Composer. You can add your composer.json require section:
```json
"xuma/laravel-amaran": "1.1.0"
```
Don't forget to update `composer update`.
Once this operation is complete, simply add both the service provider and facade classes to your project's `config/app.php` file:
#### Service Provider
```php
Xuma\Amaran\AmaranServiceProvider::class,
```
#### Facade
```php
'Amaran' => Xuma\Amaran\Facades\Amaran::class,
```
#### Installing AmaranJS jQuery Plugin
You can choose to install AmaranJS manually or you can publish assets.
If you choose install manually, extract your [AmaranJS][1] files to public/ directory. You can find installation documentation of [AmaranJS][1] [here][1].
You can publish assets with below command and assets will be placed in /css, /js folders.
```php
php artisan vendor:publish --provider="Xuma\Amaran\AmaranServiceProvider" --tag="assets"
```
#### Default configuration.
If you want to use same configuration by default you can use configuration file. You can publish configuration file with below command.
```php
php artisan vendor:publish --provider="Xuma\Amaran\AmaranServiceProvider" --tag="config"
```
#### Adding Output View
Add required view after your jQuery and AmaranJS links.
```php
@include('amaran::javascript')
```
Example:
```php
@include('amaran::javascript')
```
Usage
-----
Usage is very simple.If you want to use default theme;
```php
Amaran::content(['message'=>'Hello World!'])->create();
```
#### Using AmaranJS Functions
You can use most [AmaranJS][1] functions as methods like :
```php
Amaran::content([ 'message'=>'Hello World!'])
->position('top right')
->inEffect('slideRight')
->outEffect('slideBottom')
->sticky(true)
->create();
```
#### Binding Javascript Events to Element
You can define javascript events with `bind()` method
```php
Amaran::content(['message'=>'Hello World!'])
->position('top right')
->bind('#start','click')
- >create();
```
#### Using as Flash Message
Normally AmaranJS bind to current view but you can add ```->flash()``` method for bind to redirected methods view.
```php
Amaran::content(['message'=>'Hello World'])->flash()->create();
```
Theme Usage
-----
Theme usage is simple just set theme name and set content as theme template array.
```php
Amaran::theme('awesome ok')->content([
'title'=>'My first funcy example!',
'message'=>'1.4 GB',
'info'=>'my_birthday.mp4',
'icon'=>'fa fa-download'
])->create();
```
> Little note if you want to use awesome theme you have to include [font awesome][2].
[1]: https://github.com/hakanersu/AmaranJS
[2]: http://fortawesome.github.io/Font-Awesome/icons/