Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ile/derby-flash
Flash message middleware for Derby.js
https://github.com/ile/derby-flash
Last synced: 26 days ago
JSON representation
Flash message middleware for Derby.js
- Host: GitHub
- URL: https://github.com/ile/derby-flash
- Owner: ile
- Created: 2013-03-04T03:46:46.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-11-01T01:04:46.000Z (about 10 years ago)
- Last Synced: 2024-10-17T03:31:03.143Z (about 2 months ago)
- Language: CoffeeScript
- Homepage: https://derby-demos.herokuapp.com/derby-flash
- Size: 480 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-derby - derby-flash - Flash messages (Components)
README
#Derby-flash
This is similar to [connect-flash](https://github.com/jaredhanson/connect-flash) but for [Derby](http://derbyjs.com/).
Derby-flash should work along connect-flash; the messages from connect-flash will be accessible from this module.
##Demo
https://derby-demos.herokuapp.com/derby-flash
##Requirements
- [Node.js](http://nodejs.org)
- [Derby](http://derbyjs.com/)
##Installation
`npm install derby-flash`
##Example app
Try the example app in the `example` folder!
```
npm install derby-flash
cd node_modules/derby-flash/example
npm install
node server.js
```
##Usage
###Initialization
```javascript
app.component(require('derby-flash')(app))
```
Derby-flash also accepts an `options` object:
```javascript
app.component(require('derby-flash')(app, { useToast: true }))
```
Currently the supported options are:
- **useToast: boolean**
use [derby-ui-toast](https://github.com/ile/derby-ui-toast) to show the messages, if available.
###CSS
This serves as an example stylesheet, import this from `index.styl` to use it.
```css
@import '../../node_modules/derby-flash'
```
###In templates
```html
```
###Adding messages
```javascript
model.flash('error', 'An error happened!');
```
##License
(The MIT License)
Copyright (c) 2013-2014 Ilkka Huotari
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.