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

https://github.com/srph/angular-flash

An AngularJS module that allows you to flash a notification to the DOM
https://github.com/srph/angular-flash

Last synced: 3 months ago
JSON representation

An AngularJS module that allows you to flash a notification to the DOM

Awesome Lists containing this project

README

          

angular-flash
=============

**I am no longer supporting this project.** ***TL;DR*** **: Project dropped.**

An AngularJS module that allows you to flash a notification to the DOM.

The primary reason that this was created was due to other modules, although superior in terms of usability and stability, lacks documentation which makes it difficult for others to help, maintain, and improve the tool.

To brag, this tool was meant to be as simple as possible.

## Aim ##

- Not to be better than the existing libraries, but to provide more broad abilities
- A fully documented source code
- Custom types, templates, and namespaces (different namespaces introduces us to custom template and types for each). Why? This allows something like Twitter's flash messages (when something goes wrong, it flashes a message on top. For notifications, something pops up on the lower right.)

1. [Getting Started](https://github.com/srph/angular-flash/wiki/2.-Getting-Started)
2. [Extended](https://github.com/srph/angular-flash/wiki/3.-Extended)
3. [API](https://github.com/srph/angular-flash/wiki/4.-API)

## Example ##

To use the included example:

Some requirements include:

- npm
- nodejs
- growl (windows users)

To test (on the root directory):

```
npm install -g bower
npm install -g gulp
npm install

gulp
```

## Screenies ##

Check [wiki:screenies](https://github.com/srph/angular-flash/wiki/Screenies)

## To do ##

For more updates, do check the [Trello](https://trello.com/b/5soqLral/ng-flash)

## Changelog ##

Check [wiki:changelog](https://github.com/srph/angular-flash/wiki/Changelog)