Swiftpack.co - Package - nodes-vapor/flash

Flash ⚡️

Swift Version Vapor Version Circle CI codebeat badge codecov Readme Score GitHub license

This package allows you to display Flash messages between your views.



Add Flash to the package dependencies (in your Package.swift file):

dependencies: [
    .package(url: "https://github.com/nodes-vapor/flash.git", from: "4.0.0")

as well as to your target (e.g. "App"):

targets: [
        name: "App",
        dependencies: [... "Flash" ...]

Getting started 🚀

First make sure that you've imported Flash everywhere when needed:

import Flash

Adding the provider

public func configure(_ config: inout Config, _ env: inout Environment, _ services: inout Services) throws {
    try services.register(FlashProvider())

Adding the middleware

You can either add the Flash middleware globally by doing:

func configure(_ app: Application) throws {

Alternatively, you can add the middleware to individual route groups where needed:

router.grouped([SessionsMiddleware(driver: app.sessions.driver), FlashMiddleware()]) { router in
    // .. routes

Please note that the SessionsMiddleware needs to be added to the same route groups where Flash is added.

Adding the Leaf tag

In order to render Flash messages, you will need to add the Flash Leaf tag to your application:

func configure(_ app: Application) throws {
    app.leaf.tags["flashes"] = FlashTag()

Using Flash messages

With Flash set up, you are now able to redirect while adding a Flash message, given a Request:

request.redirect(to: "/users").flash(.success, "Successfully saved")
request.redirect(to: "/users").flash(.info, "Email sent")
request.redirect(to: "/users").flash(.warning, "Updated user")
request.redirect(to: "/users").flash(.error, "Something went wrong")

Example of HTML

This package comes with a Leaf tag that makes it easy and convenient to display Flash messages. We suggest to use the Bootstrap package for rendering Bootstrap elements, but this package does not depend on it.

It's possible to loop through the different kinds of messages using:

  • all: All Flash messages no matter the kind.
  • successes: All Flash messages of type success.
  • information: All Flash messages of type info.
  • warnings: All Flash messages of type warning.
  • errors: All Flash messages of type error.

Further, using the message property you will be able to pull out the message of the Flash message. You can also get the kind by using the kind property. This property will hold one of the following values: success, info, warning or error. Lastly, you can use the bootstrapClass to get the relevant Bootstrap class:

  • success will return success.
  • info will return info.
  • warning will return warning.
  • error will return danger.

Not using the Bootstrap package

Without using any dependencies, this is how Flash messages could be rendered:

<div class="alerts">
#for(flash in flashes().all):
        Message: #(flash.message)
        Type: #(flash.kind)

Using the Bootstrap package

The below example uses the Vapor 3 Bootstrap package for generating the alert html.

<div class="alerts">
    #for(flash in flashes().all):
        #bs:alert(flash.bootstrapClass) {

Add the Flash html to one file and embed it in rest of your views or through a base layout, e.g.: #embed("alerts").

🏆 Credits

This package is developed and maintained by the Vapor team at Nodes.

📄 License

This package is open-sourced software licensed under the MIT license


Stars: 31


Used By

Total: 0


Version 6.0.0 Beta 1 - 2020-04-28 07:27:07


  • Adjusted to Vapor 4 and Leaf (RC) (thanks @tonyarnold!)

Version 5.0.0 RC 2 - 2019-05-07 11:18:45


  • Fixed Swift 5 compiler warnings related to redundant access modifiers

Version 5.0.0 RC 1 - 2019-03-06 15:16:22


  • It is not necessary anymore to render on a privateContainer. But you have to add the request when rendering: req.view().render("path-to-template", on: req)

Version 4.0.0 - 2018-12-11 09:23:21


  • Correctly specified 4.1 as the minimum required Swift version.


  • This package no longer uses the MutableLeafTagConfig. Please use useFlashLeafTags() for registering this package's Leaf tags (see readme for more info).

Version 3.0.0 - 2018-06-21 10:28:29


  • Uses Sugars new MutableLeafTagConfig to register the tag.
  • Removed the static tags from the FlashProvider.

Version 1.0.1 - 2018-06-20 12:31:02

This release is compatible with Vapor 2


  • Fixed strong reference cycle that lead to leaking Request and Helper

Version 2.0.0 - 2018-06-11 09:21:09


  • Flash has been rewritten to support Vapor 3.

Version 2.0.0 Beta 3 - 2018-06-05 12:11:44


  • bootstrapType renamed to bootstrapClass.

Version 2.0.0 Beta 2 - 2018-05-04 16:28:53


  • Made the EventLoopFuture extension public (thanks @mcdappdev)

Version 2.0.0 Beta 1 - 2018-05-04 15:04:03


  • More or less everything. This release supports Vapor 3 🎉

Version 1.0.0 - 2017-05-18 20:56:44

  • Vapor 2 released 🎉

Version 1.0.0 Beta 1 - 2017-04-27 10:48:49

  • Ready for Vapor 2

Version 0.1.0 - 2017-01-04 21:43:29

  • Initial release