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: [
...
.target(
name: "App",
dependencies: [... "Flash" ...]
),
...
]First make sure that you've imported Flash everywhere when needed:
import Flashpublic func configure(_ config: inout Config, _ env: inout Environment, _ services: inout Services) throws {
try services.register(FlashProvider())
}You can either add the Flash middleware globally by doing:
func configure(_ app: Application) throws {
app.middleware.use(FlashMiddleware())
}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.
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()
}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")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 typesuccess.information: All Flash messages of typeinfo.warnings: All Flash messages of typewarning.errors: All Flash messages of typeerror.
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:
successwill returnsuccess.infowill returninfo.warningwill returnwarning.errorwill returndanger.
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)
#endfor
</div>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) {
#(flash.message)
}
#endfor
</div>Add the Flash html to one file and embed it in rest of your views or through a base layout, e.g.: #embed("alerts").
This package is developed and maintained by the Vapor team at Nodes.
This package is open-sourced software licensed under the MIT license