Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nicoaudy/laravel-noty

Elegant Flash Message Wrapper For Laravel
https://github.com/nicoaudy/laravel-noty

Last synced: about 6 hours ago
JSON representation

Elegant Flash Message Wrapper For Laravel

Awesome Lists containing this project

README

        

# Elegant Flash Message Wrapper For Laravel

[![License](https://img.shields.io/github/license/nicoaudy/laravel-noty?style=flat-square)](https://packagist.org/packages/nicoaudy/noty)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/nicoaudy/noty.svg?style=flat-square)](https://packagist.org/packages/nicoaudy/noty)
[![Total Downloads](https://img.shields.io/packagist/dt/nicoaudy/noty.svg?style=flat-square)](https://packagist.org/packages/nicoaudy/noty)

This is a elegant and configurable notify package to send flash messages in Laravel apps. A flash message is a message that is carried over to the next request by storing it in the session.

![Screenshot](./screenshots/noty-screenshot.png "Screenshot")

This is how it can be used:

## Installation

You can install the package via composer:

```bash
composer require nicoaudy/noty
```

You can publish the config file with:

```bash
php artisan vendor:publish --provider="Nicoaudy\Noty\NotyServiceProvider"
```

This is the contents of the published config file:

```php
return [
/*
* Title configuration color
*/
'titleColor' => '',

/*
* Title configuration size
*/
'titleSize' => '',

/*
* Title configuration line hight
*/
'titleLineHeight' => '',

/*
* Message configuration color
*/
'messageColor' => '',

/*
* Message configuration size
*/
'messageSize' => '',

/*
* Message configuration line hight
*/
'messageLineHeight' => '',

/*
* Positions: bottomRight, bottomLeft, topRight, topLeft, topCenter, bottomCenter, center
*/
'position' => 'topRight',

/*
* Themes: light, dark
*/
'theme' => 'light',

/*
* Layout: 1 (title inline with message), 2 (title on top of message)
*/
'layout' => 1,

/*
* [integer|boolean] - Delay for closing event in milliseconds. Set false for sticky notifications.
*/
'timeout' => 4000,

/*
* [boolean] - Displays a progress bar.
*/
'progressBar' => true,

/*
* [string] - Progress bar color
*/
'progressBarColor' => 'rgb(0, 255, 184)',

/*
* [string] - Progress bar linear / ease
*/
'progressBarEasing' => 'linear',

/*
* [boolean] - Balloon
*/
'balloon' => true,

/*
* [boolean] - enable to close?
*/
'close' => true,

/*
* [boolean] - Close on click
*/
'closeOnClick' => false,

/*
* [boolean] - Close on escape?
*/
'closeOnEscape' => false,

/*
* Animate inside
*/
'animateInside' => true, // bool

/*
* Enable drag for close
*/
'drag' => true, // bool

/*
* Pause on hover
*/
'pauseOnHover' => true, // bool

/*
* Reset on hover
*/
'resetOnHover' => false, // bool

/*
* [string] - Transition In
* Default toast open animation. It can be: bounceInLeft, bounceInRight, bounceInUp, bounceInDown, fadeIn, fadeInDown, fadeInUp, fadeInLeft, fadeInRight or flipInX.
*/
'transitionIn' => 'fadeInUp',

/*
* [string] - Transition Out
* Default toast close animation. It can be: fadeOut, fadeOutUp, fadeOutDown, fadeOutLeft, fadeOutRight, flipOutX
*/
'transitionOut' => 'fadeOut',

/*
* [string] - Transition In Mobile
*/
'transitionInMobile' => 'fadeInUp',

/*
* [string] - Transition Out Mobile
*/
'transitionOutMobile' => 'fadeOutDown',
];
```

Because flash messages are so common, we provide a template out of the box to get you started. Place this before end of the body tag.

```php
{{ noty_assets() }}