derby-flash

Flash messages for Derby

#Derby-flash

This is similar to connect-flash but for Derby.

Derby-flash should work along connect-flash; the messages from connect-flash will be accessible from this module.

##Requirements

##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

app.component(require('derby-flash')(app))

Derby-flash also accepts an options object:

app.component(require('derby-flash')(app, { useToast: true }))

Currently the supported options are:

  • useToast: boolean use derby-ui-toast to show the messages, if available.

###CSS

This serves as an example stylesheet, import this from index.styl to use it.

@import '../../node_modules/derby-flash' 

###In templates

<view name="derby-flash"></view>

###Adding messages

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.