Lucid.Base

Base types and combinators.

Rendering

renderText :: Html a -> Text

Render the HTML to a lazy Text.

This is a convenience function defined in terms of execHtmlT, runIdentity and toLazyByteString, and decodeUtf8. Check the source if you're interested in the lower-level behaviour.

renderBS :: Html a -> ByteString

Render the HTML to a lazy ByteString.

This is a convenience function defined in terms of execHtmlT, runIdentity and toLazyByteString. Check the source if you're interested in the lower-level behaviour.

renderTextT :: Monad m => HtmlT m a -> m Text

Render the HTML to a lazy Text, but in a monad.

This is a convenience function defined in terms of execHtmlT and toLazyByteString, and decodeUtf8. Check the source if you're interested in the lower-level behaviour.

renderBST :: Monad m => HtmlT m a -> m ByteString

Render the HTML to a lazy ByteString, but in a monad.

This is a convenience function defined in terms of execHtmlT and toLazyByteString. Check the source if you're interested in the lower-level behaviour.

renderToFile :: FilePath -> Html a -> IO ()

Render the HTML to a lazy ByteString.

This is a convenience function defined in terms of execHtmlT, runIdentity and toLazyByteString. Check the source if you're interested in the lower-level behaviour.

Running

execHtmlT

Arguments

:: Monad m

=> HtmlT m a

The HTML to generate.

-> m Builder

The a is discarded.

Build the HTML. Analogous to execState.

You might want to use this is if you want to do something with the raw Builder. Otherwise for simple cases you can just use renderText or renderBS.

evalHtmlT

Arguments

:: Monad m

=> HtmlT m a

HTML monad to evaluate.

-> m a

Ignore the HTML output and just return the value.

Evaluate the HTML to its return value. Analogous to evalState.

Use this if you want to ignore the HTML output of an action completely and just get the result.

For using with the Html type, you'll need runIdentity e.g.

>>> runIdentity (evalHtmlT (p_ "Hello!"))
()

runHtmlT :: HtmlT m a -> m (HashMap Text Text -> Builder -> Builder, a)

This is the low-level way to run the HTML transformer, finally returning an element builder and a value. You can pass mempty for both arguments for a top-level call. See evalHtmlT and execHtmlT for easier to use functions.

Combinators

makeElement

Arguments

:: Monad m

=> Builder

Name.

-> HtmlT m a

Children HTML.

-> HtmlT m ()

A parent element.

Make an HTML builder.

makeElementNoEnd

Arguments

:: Monad m

=> Builder

Name.

-> HtmlT m ()

A parent element.

Make an HTML builder for

Types

type Html = HtmlT Identity

Simple HTML builder type. Defined in terms of HtmlT. Check out that type for instance information.

Simple use-cases will just use this type. But if you want to transformer over Reader or something, you can go and use HtmlT.

data HtmlT m a

A monad transformer that generates HTML. Use the simpler Html type if you don't want to transform over some other monad.

Instances

MonadTrans HtmlT

Used for lift.

(Monad m, ToHtml a, (~) * r ()) => MixedRaw a (HtmlT m r)

HTML elements can be a mixed thing e.g. style_. Doesn't encode the text content.

(Monad m, (~) * a (HtmlT m r), (~) * r ()) => Mixed a (HtmlT m r)

HTML elements can be a mixed thing e.g. style_.

Monad m => Monad (HtmlT m)

Basically acts like Writer.

Monad m => Functor (HtmlT m)

Just re-uses Monad.

Monad m => Applicative (HtmlT m)

Based on the monad instance.

Monoid a => Monoid (Html a)

Monoid is right-associative, a la the Builder in it.

MonadIO m => MonadIO (HtmlT m)

If you want to use IO in your HTML generation.

(~) (* -> *) m Identity => Show (HtmlT m a)

Just calls renderText.

(Monad m, (~) * a ()) => IsString (HtmlT m a)

We pack it via string. Could possibly encode straight into a builder. That might be faster.

(Monad m, (~) * a ()) => With (HtmlT m a -> HtmlT m a)

For the contentful elements: div_

(Monad m, (~) * a ()) => With (HtmlT m a)

For the contentless elements: br_

Classes

class ToHtml a where

Can be converted to HTML.

Methods

toHtml :: Monad m => a -> HtmlT m ()

toHtmlRaw :: Monad m => a -> HtmlT m ()

Instances

ToHtml String

ToHtml Text

class Mixed a r where

Used for names that are mixed, e.g. style_.

Methods

mixed :: Text -> a -> r

Instances

(Monad m, (~) * a (HtmlT m r), (~) * r ()) => Mixed a (HtmlT m r)

HTML elements can be a mixed thing e.g. style_.

(~) * a Text => Mixed a (Text, Text)

Attributes can be a mixed thing e.g. style_.

class MixedRaw a r where

Used for names that are mixed, e.g. style_. Doesn't encode the inner content of its element.

Methods

mixedRaw :: Text -> a -> r

Instances

(Monad m, ToHtml a, (~) * r ()) => MixedRaw a (HtmlT m r)

HTML elements can be a mixed thing e.g. style_. Doesn't encode the text content.

(~) * a Text => MixedRaw a (Text, Text)

Attributes can be a mixed thing e.g. style_.

class With a where

With an element use these attributes.

Methods

with

Arguments

:: a

Some element, either Html () or Html () -> Html ().

-> [(Text, Text)]

-> a

With the given element(s), use the given attributes.

Instances

(Monad m, (~) * a ()) => With (HtmlT m a -> HtmlT m a)

For the contentful elements: div_

(Monad m, (~) * a ()) => With (HtmlT m a)

For the contentless elements: br_