Shpadoinkle.Router.Server

Since the single page application URIs are specified with Servant, we can automate much of the process of serving the application with server-side rendering. This module provides the basic infrastructure for serving rendered HTML using the same code that would be used to render the same route on the client-side, ensuring a consistent rendering, whether a URI is accessed via a client-side popstate event or via the initial page load.

Documentation

toFile :: Piece -> ByteString -> File

Helper to serve a ByteString as a file from the web application interface.

defaultSPAServerSettings

Arguments

:: FilePath

Directory to try files

-> IO (Html m a)

Get the index.html page

-> StaticSettings

Serve index.html generated from a Shpadoinkle view using the static backend, otherwise serve out of a directory.

class ServeRouter layout route where

Serve the UI by generating a Servant Server from the SPA URIs

Methods

serveUI

Arguments

:: FilePath

Where should we look for static assets?

-> (route -> IO (Html m a))

How shall we get the page based on the requested route?

-> (layout :>> route)

What is the relationship between URIs and routes?

-> Server layout

Instances

ServeRouter Raw r

Defined in Shpadoinkle.Router.Server

Methods

serveUI :: FilePath -> (r -> IO (Html m a)) -> (Raw :>> r) -> Server Raw

(ServeRouter x r, ServeRouter y r) => ServeRouter (x :<|> y) r

Defined in Shpadoinkle.Router.Server

Methods

serveUI :: FilePath -> (r -> IO (Html m a)) -> ((x :<|> y) :>> r) -> Server (x :<|> y)

ServeRouter sub r => ServeRouter (QueryParam sym x :> sub) r

Defined in Shpadoinkle.Router.Server

Methods

serveUI :: FilePath -> (r -> IO (Html m a)) -> ((QueryParam sym x :> sub) :>> r) -> Server (QueryParam sym x :> sub)

ServeRouter sub r => ServeRouter (QueryParams sym x :> sub) r

Defined in Shpadoinkle.Router.Server

Methods

serveUI :: FilePath -> (r -> IO (Html m a)) -> ((QueryParams sym x :> sub) :>> r) -> Server (QueryParams sym x :> sub)

ServeRouter sub r => ServeRouter (QueryFlag sym :> sub) r

Defined in Shpadoinkle.Router.Server

Methods

serveUI :: FilePath -> (r -> IO (Html m a)) -> ((QueryFlag sym :> sub) :>> r) -> Server (QueryFlag sym :> sub)

ServeRouter sub r => ServeRouter (Capture sym x :> sub) r

Defined in Shpadoinkle.Router.Server

Methods

serveUI :: FilePath -> (r -> IO (Html m a)) -> ((Capture sym x :> sub) :>> r) -> Server (Capture sym x :> sub)

ServeRouter sub r => ServeRouter (path :> sub) r

Defined in Shpadoinkle.Router.Server

Methods

serveUI :: FilePath -> (r -> IO (Html m a)) -> ((path :> sub) :>> r) -> Server (path :> sub)