express-flash-notification
Advanced tools
Readme
This module provides a way to set one-time notifications to be displayed during or after processing a request. Notifications are stored in session and are removed once they have been rendered.
Key Points
connect-flash is nice if your template engine can do some conditional logic like EJS however, if you are using a logic-less engine, like hogan-express things get akward IMO.
I needed something simple like:
req.flash('info', 'my message')
in my controller/middleware and
{{{flash}}}
in my layout
Then the HTML for each alert gets placed in {{{flash}}} including some client side javascript so it doesn't just appear $(elm).slideDown() FTW
While at the same time, adding the markup nessary to display the alert depending on its type (so info is blue, error is red, etc).
npm install express-flash-notification --save
Flash notifications are stored in the session. You will need the cookieParser middleware and the session middleware. Depending on your express version it may be bundled in express or for the newer releases you'll have to npm install them as seperate modules. I'm using express 4.x in the following examples.
You must pass the express application instance as the first argument in the flash() middleware so app.render can be used to create your notification using your chosen template engine and views directory.
var flash = require('express-flash-notification')
var cookieParser = require('cookie-parser')
var session = require('express-session')
var app = express()
// setup views directory, view engine, etc...
app.use(cookieParser())
app.use(session({...}}))
app.use(flash(app))
Wherever you place the local variable flash, it will be populated with the notifications if there are any. Make sure it does not escape, as the output may be HTML.
<<!DOCTYPE html>
<html>
<head>
<title></title>
</head>
<body>
{{{flash}}}
</body>
</html>
By default, a view called flash in your views directory will be retrieved and used as the default template for your notifications.
The local variables type and message will be set, depending on the type and message passed when calling req.render
flash.html (I'm using mustache in this example)
<div class="alert flash">
<button type="button" class="close">×</button>
<i class="fa sign"></i><strong>{{type}}</strong>
<span>{{message}}</span>
</div>
Note A notification is an object where its properties become the local variables when rendering the it using the express rendering engine of your choice.
req.flash(String)
Sets local variable message to the string provided, type will become an empty string. Will refresh the current page.
req.flash(String, String)
First string is the type local variable, the second is the message local variable. Will refresh the current page.
req.flash(String, String, String) Similar to to above, except last argument as a string defines which page to redirect to.
req.flash(String, String, Boolean)
Same as above. Third variable as a boolean decides whether or not to refresh the page.
NOTE If set to false, notification will not be rendered until the next request. If you want the notification to be rendered on the current request, you can use a function that is returned by req.flash, simply call the function with a callback, the callback will be executed once rendering is complete.
example
app.all(function SampleExpressRoute(req, res){
var manualRender = req.flash('warn', 'tell them now!', false)
manualRender(function(err){
if (err) throw err
res.render('layouts/internal')
})
})
req.flash(object)
You can pass an object as the first argument, the object's properties will be exposed as local variables when rendering the notification template.
The property redirect is reserved and functions just as you'd expect; a Boolean determines if it will refresh, or as a String you specify where to redirect to.
req.flash('info', 'if cats ruled the world', false)
is treated exactly the same as:
req.flash({
type: 'info',
message: 'if cats rules the world',
redirect: false
})
With the flash middleware in place, all requests will have a req.flash() method to send out flash notifications.
app.use('/login', function loginProcessor(req, res, next){
if (req.method !== 'POST') return next()
if (!req.body) return next(new Error('no data was sent to the server, please try again'))
var user = req.body.user
var pass = req.body.pass
if (user && pass)
{
if (user === 'root' && pass === 'toor')
{
res.redirect('/dashboard')
}
else
{
req.flash('info', 'invalid username or password')
}
}
else
{
req.flash('info', 'you must enter your username and password to login')
}
})
app.use('/login', function loginErrorHandler(err, req, res, next){
if (err.message)
{
req.flash('error', err.message)
}
else
{
console.log('there was a nasty login error: %s', err.stack)
next()
}
})
app.get('/login', function loginRenderer(req, res, next){
res.render('external', {
partials: {
content: 'external/login'
}
})
})
By default, req.flash will redirect to the current url, effectively refreshing the page so to display the flash notification. It is important that your logic uses return when using flash or conditioning so you don't get the headers have already been sent error.
For example below, if 2 + 2 ever equals 'fish' the req.flash method will send out the redirect headers, and execution will continue until the next function is called, next will also try to set the response headers
app.use('/get-busy', function(req, res, next){
if (2 + 2 === 'fish')
{
req.flash('error', 'fairies!')
}
// ... other logics go here
next()
})
In the case above, and in case you want to send multiple notifications you can disable the redirect by setting the third parameter to false
app.use('/get-busy', function(req, res, next){
if (2 + 2 === 'fish')
{
return req.flash('error', 'fairies!', '/impossible')
}
// ... other logics go here
req.flash('success', 'logics are done', false)
next()
})
When setting the flash middleware, the second parameter accepts an object for configuration. Below is an example with all the options set to their defaults
app.use(flash(app, {
session_name: 'flash',
utility_name: 'flash',
locals_name: 'flash',
view_name: 'flash',
beforeSingleRender: function(item, callback){callback(null, item)},
afterAllRender: function(htmlFragments, callback){callback(null, htmlFragments.join('\n'))}
}))
session_name Is the key used to store the notifications in session: req.session[session_name]
utility_name Is the name of the function that is exposed in the req object, the one used to add new notifications: req[utility_name]('info', 'hello')
locals_name Is the locals variable name where all your notifications will be placed, make sure it does not escape HTML: {{{locals_name}}}
view_name Is the name of the view that will be used as the template for all notifications: app/views/view_name.html
beforeSingleRender Is called right before each notification is rendered, allowing you to add/remove or modify the local variables passed to the renderer.
The first argument is an object with all the locals variables set, typically you will find item.type and item.message here. The second argument is a callback that must be called with null or an Error for the first parameter, and an object with the locals used to render on the second parameter.
afterAllRender Is called after all notifications have been compiled. Allowing you to append anything like extra HTML to the output.
The first argument, is an array with each rendered notification. The second argument is a callback that must be called with null or an Error for the first parameter, and the resulting notifications output not as an Array but as a String (Array.join)
Heres an example where custom notifications will be rendered, beforeSingleRender is used to add class names depending on the type of notification so the resulting notification looks different depending on its type. Also, afterAllRender will be used to append some javascript so notification don't just appear, they slide into view.
NOTE {{{flash}}} is placed in my layout, not shown here
This is my flash.html view template.
alert_class and icon_class will be populated inside of beforeSingleRender
style="display: none" is set so the appended javascript uses jQuery's slideDown method to animate its presentation
<div class="alert flash {{alert_class}}" style="display:none">
<button type="button" class="close">×</button>
<i class="fa {{icon_class}} sign"></i><strong>{{type}}</strong>
<span>{{{message}}}</span>
</div>
This is the setup
app.use(require('express-flash-notification')(app, {
view_name: 'elements/flash',
beforeSingleRender: function(notification, callback)
{
if (notification.type)
{
switch(notification.type)
{
case 'error':
notification.alert_class = 'alert-danger'
notification.icon_class = 'fa-times-circle'
break;
case 'alert':
notification.alert_class = 'alert-warning'
notification.icon_class = 'fa-times-circle'
break;
case 'info':
notification.alert_class = 'alert-info'
notification.icon_class = 'fa-times-circle'
break;
case 'success':
notification.alert_class = 'alert-success'
notification.icon_class = 'fa-check'
break;
case 'ok':
notification.alert_class = 'alert-primary'
notification.icon_class = 'fa-check'
break;
}
}
callback(null, notification)
},
afterAllRender: function(htmlFragments, callback)
{
// Naive JS is appened, waits a while expecting for the DOM to finish loading,
// The timeout can be removed if jOuery is loaded before this is called, or if you're using vanilla js.
htmlFragments.push([
'<script type="text/javascript">',
' var timer = setInterval(function(){',
' if (window.jOuery){',
' clearInterval(timer)',
' $(".alert.flash").slideDown().find(".close").on("click", function(){$(this).parent().slideUp()})',
' }',
' }, 200)',
'</script>',
].join(''))
callback(null, htmlFragments.join(''))
},
}))
And this is how you'd use it
app.use('/bleh/:ok', function(req, res, next){
if (req.params.ok)
{
req.flash('ok', 'Everything is A-O-K')
}
else
{
req.flash('warn', 'Quick! everybody panic!')
}
})
FAQs
Express.js flash notifications that works with any template engine
We found that express-flash-notification demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.