Web.Simple.Templates

Documentation

class Monad m => HasTemplates m hs where

Minimal complete definition

Nothing

Methods

defaultLayout :: ControllerT hs m (Maybe Template)

The layout to use by default. Layouts are just templates that embed views. They are rendered with the a global object containing the rendered view in the "yield" field, and the object the view was rendered with in the "page" field. By default, no template is used.

viewDirectory :: ControllerT hs m FilePath

The directory to look for views passed to render. This defaults to "views", so

render "index.html.tmpl" ...

will look for a view template in "views/index.html.tmpl".

functionMap :: ControllerT hs m FunctionMap

A map of pure functions that can be called from within a template. See FunctionMap and Function for details.

getTemplate :: FilePath -> ControllerT hs m Template

Function to use to get a template. By default, it looks in the viewDirectory for the given file name and compiles the file into a template. This can be overriden to, for example, cache compiled templates in memory.

getTemplate :: MonadIO m => FilePath -> ControllerT hs m Template

Function to use to get a template. By default, it looks in the viewDirectory for the given file name and compiles the file into a template. This can be overriden to, for example, cache compiled templates in memory.

layoutObject :: (ToJSON pageContent, ToJSON pageVal) => pageContent -> pageVal -> ControllerT hs m Value

The Value passed to a layout given the rendered view template and the value originally passed to the view template. By default, produces an Value with "yield", containing the rendered view, and "page", containing the value originally passed to the view.

render

Arguments

:: (HasTemplates m hs, Monad m, ToJSON a)

=> FilePath

Template to render

-> a

Aeson Value to pass to the template

-> ControllerT hs m ()

Renders a view template with the default layout and a global used to evaluate variables in the template.

renderPlain

Arguments

:: (HasTemplates m hs, ToJSON a)

=> FilePath

Template to render

-> a

Aeson Value to pass to the template

-> ControllerT hs m ()

Same as render but without a template.

renderLayout :: (HasTemplates m hs, ToJSON a) => FilePath -> FilePath -> a -> ControllerT hs m ()

Render a view using the layout named by the first argument.

renderLayoutTmpl :: (HasTemplates m hs, ToJSON a) => Template -> Template -> a -> ByteString -> ControllerT hs m ()

Same as renderLayout but uses already compiled layouts.

defaultGetTemplate :: (HasTemplates m hs, MonadIO m) => FilePath -> ControllerT hs m Template

defaultFunctionMap :: FunctionMap

defaultLayoutObject :: (HasTemplates m hs, ToJSON pageContent, ToJSON pageVal) => pageContent -> pageVal -> ControllerT hs m Value

fromList :: (Eq k, Hashable k) => [(k, v)] -> HashMap k v

O(n*log n) Construct a map with the supplied mappings. If the list contains duplicate mappings, the later mappings take precedence.

newtype Function

A funcation that's callable from inside a template

Constructors

Function

Fields

• call :: [Value] -> Value

class ToFunction a where

Methods

toFunction :: a -> Function

Instances

FromJSON a => ToFunction (a -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a -> Value) -> Function

(FromJSON a1, FromJSON a2) => ToFunction (a1 -> a2 -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a1 -> a2 -> Value) -> Function

(FromJSON a1, FromJSON a2, FromJSON a3) => ToFunction (a1 -> a2 -> a3 -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a1 -> a2 -> a3 -> Value) -> Function

(FromJSON a1, FromJSON a2, FromJSON a3, FromJSON a4) => ToFunction (a1 -> a2 -> a3 -> a4 -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a1 -> a2 -> a3 -> a4 -> Value) -> Function

(FromJSON a1, FromJSON a2, FromJSON a3, FromJSON a4, FromJSON a5) => ToFunction (a1 -> a2 -> a3 -> a4 -> a5 -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a1 -> a2 -> a3 -> a4 -> a5 -> Value) -> Function

(FromJSON a1, FromJSON a2, FromJSON a3, FromJSON a4, FromJSON a5, FromJSON a6) => ToFunction (a1 -> a2 -> a3 -> a4 -> a5 -> a6 -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a1 -> a2 -> a3 -> a4 -> a5 -> a6 -> Value) -> Function

(FromJSON a1, FromJSON a2, FromJSON a3, FromJSON a4, FromJSON a5, FromJSON a6, FromJSON a7) => ToFunction (a1 -> a2 -> a3 -> a4 -> a5 -> a6 -> a7 -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a1 -> a2 -> a3 -> a4 -> a5 -> a6 -> a7 -> Value) -> Function

(FromJSON a1, FromJSON a2, FromJSON a3, FromJSON a4, FromJSON a5, FromJSON a6, FromJSON a7, FromJSON a8) => ToFunction (a1 -> a2 -> a3 -> a4 -> a5 -> a6 -> a7 -> a8 -> Value)

Defined in Web.Simple.Templates.Types

Methods

toFunction :: (a1 -> a2 -> a3 -> a4 -> a5 -> a6 -> a7 -> a8 -> Value) -> Function

type FunctionMap = HashMap Identifier Function