Text.Julius

A Shakespearean module for Javascript templates, introducing type-safe, compile-time variable and url interpolation.--

You might consider trying Typescript or Coffee which compile down to Javascript.

Further reading: http://www.yesodweb.com/book/shakespearean-templates

Functions

Template-Reading Functions

These QuasiQuoter and Template Haskell methods return values of type JavascriptUrl url. See the Yesod book for details.

js :: QuasiQuoter

julius :: QuasiQuoter

juliusFile :: FilePath -> Q Exp

jsFile :: FilePath -> Q Exp

juliusFileDebug :: FilePath -> Q Exp

Deprecated: Please use juliusFileReload instead.

jsFileDebug :: FilePath -> Q Exp

Deprecated: Please use jsFileReload instead.

juliusFileReload :: FilePath -> Q Exp

jsFileReload :: FilePath -> Q Exp

Datatypes

type JavascriptUrl url = (url -> [(Text, Text)] -> Text) -> Javascript

Return type of template-reading functions.

newtype Javascript

Newtype wrapper of Builder.

Constructors

Javascript

Fields

• unJavascript :: Builder

Instances

Semigroup Javascript

Defined in Text.Julius

Methods

(<>) :: Javascript -> Javascript -> Javascript

sconcat :: NonEmpty Javascript -> Javascript

stimes :: Integral b => b -> Javascript -> Javascript

Monoid Javascript

Defined in Text.Julius

Methods

mempty :: Javascript

mappend :: Javascript -> Javascript -> Javascript

mconcat :: [Javascript] -> Javascript

newtype RawJavascript

Constructors

RawJavascript Builder

Instances

ToJavascript RawJavascript

Defined in Text.Julius

Methods

toJavascript :: RawJavascript -> Javascript

Typeclass for interpolated variables

class ToJavascript a where

A typeclass for types that can be interpolated in CoffeeScript templates.

Methods

toJavascript :: a -> Javascript

Instances

ToJavascript Bool

Defined in Text.Julius

Methods

toJavascript :: Bool -> Javascript

ToJavascript Text

Defined in Text.Julius

Methods

toJavascript :: Text -> Javascript

ToJavascript Value

Defined in Text.Julius

Methods

toJavascript :: Value -> Javascript

ToJavascript Text

Defined in Text.Julius

Methods

toJavascript :: Text -> Javascript

ToJavascript String

Defined in Text.Julius

Methods

toJavascript :: String -> Javascript

ToJavascript RawJavascript

Defined in Text.Julius

Methods

toJavascript :: RawJavascript -> Javascript

class RawJS a where

Methods

rawJS :: a -> RawJavascript

Instances

RawJS Bool

Defined in Text.Julius

Methods

rawJS :: Bool -> RawJavascript

RawJS Builder

Defined in Text.Julius

Methods

rawJS :: Builder -> RawJavascript

RawJS Text

Defined in Text.Julius

Methods

rawJS :: Text -> RawJavascript

RawJS Text

Defined in Text.Julius

Methods

rawJS :: Text -> RawJavascript

RawJS [Char]

Defined in Text.Julius

Methods

rawJS :: [Char] -> RawJavascript

Rendering Functions

renderJavascript :: Javascript -> Text

renderJavascriptUrl :: (url -> [(Text, Text)] -> Text) -> JavascriptUrl url -> Text

render with route interpolation. If using this module standalone, apart from type-safe routes, a dummy renderer can be used:

renderJavascriptUrl (\_ _ -> undefined) javascriptUrl

When using Yesod, a renderer is generated for you, which can be accessed within the GHandler monad: getUrlRenderParams.

internal, used by Coffee

javascriptSettings :: Q ShakespeareSettings

internal

juliusUsedIdentifiers :: String -> [(Deref, VarType)]

Determine which identifiers are used by the given template, useful for creating systems like yesod devel.

asJavascriptUrl :: JavascriptUrl url -> JavascriptUrl url