Safe Haskell | None |
---|---|

Language | Haskell98 |

Base types and combinators.

- renderText :: Html a -> Text
- renderBS :: Html a -> ByteString
- renderTextT :: Monad m => HtmlT m a -> m Text
- renderBST :: Monad m => HtmlT m a -> m ByteString
- renderToFile :: FilePath -> Html a -> IO ()
- execHtmlT :: Monad m => HtmlT m a -> m Builder
- evalHtmlT :: Monad m => HtmlT m a -> m a
- runHtmlT :: HtmlT m a -> m (HashMap Text Text -> Builder, a)
- makeElement :: Monad m => Text -> HtmlT m a -> HtmlT m a
- makeElementNoEnd :: Monad m => Text -> HtmlT m ()
- makeXmlElementNoEnd :: Monad m => Text -> HtmlT m ()
- makeAttribute :: Text -> Text -> Attribute
- type Html = HtmlT Identity
- data HtmlT m a
- data Attribute = Attribute !Text !Text
- class Term arg result | result -> arg where
- class TermRaw arg result | result -> arg where
- termRaw :: Text -> arg -> result
- termRawWith :: Text -> [Attribute] -> arg -> result

- class ToHtml a where
- class With a where

# Rendering

renderText :: Html a -> Text Source

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 Source

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 Source

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 Source

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 () Source

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

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`

.

:: 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!"))`

# Combinators

Make an HTML builder.

Make an HTML builder for elements which have no ending tag.

Make an XML builder for elements which have no ending tag.

Make an attribute builder.

# Types

A monad transformer that generates HTML. Use the simpler `Html`

type if you don't want to transform over some other monad.

MonadTrans HtmlT | Used for |

(Monad m, (~) * a ()) => TermRaw Text (HtmlT m a) | Given children immediately, just use that and expect no attributes. |

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. |

MonadIO m => MonadIO (HtmlT m) | If you want to use IO in your HTML generation. |

(Monad m, ToHtml f, (~) * a ()) => TermRaw [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |

(Monad m, (~) * f (HtmlT m a)) => Term [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |

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

(Monad m, (~) * a ()) => IsString (HtmlT m a) | We pack it via string. Could possibly encode straight into a builder. That might be faster. |

((~) * a (), Monad m) => Monoid (HtmlT m a) | Monoid is right-associative, a la the |

Monad m => With (HtmlT m a -> HtmlT m a) | For the contentful elements: |

Monad m => With (HtmlT m a) | For the contentless elements: |

Monad m => Term (HtmlT m a) (HtmlT m a) | Given children immediately, just use that and expect no attributes. |

A simple attribute. Don't use the constructor, use `makeAttribute`

.

Eq Attribute | |

Show Attribute | |

Hashable Attribute | |

TermRaw Text Attribute | Some termRaws (like |

Term Text Attribute | Some terms (like |

(Monad m, ToHtml f, (~) * a ()) => TermRaw [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |

(Monad m, (~) * f (HtmlT m a)) => Term [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |

# Classes

class Term arg result | result -> arg where Source

Used to construct HTML terms.

Simplest use: p_ = term "p" yields `p_`

.

Very overloaded for three cases:

- The first case is the basic
`arg`

of`[(Text,Text)]`

which will return a function that wants children. - The second is an
`arg`

which is`HtmlT m ()`

, in which case the term accepts no attributes and just the children are used for the element. - Finally, this is also used for overloaded attributes, like
`style_`

or`title_`

. If a return type of`(Text,Text)`

is inferred then an attribute will be made.

The instances look intimidating but actually the constraints make
it very general so that type inference works well even in the
presence of things like `OverloadedLists`

and such.

:: Text | Name of the element or attribute. |

-> arg | Either an attribute list or children. |

-> result | Result: either an element or an attribute. |

Used for constructing elements e.g. `term "p"`

yields `p_`

.

:: Text | Name. |

-> [Attribute] | Attribute transformer. |

-> arg | Some argument. |

-> result | Result: either an element or an attribute. |

Use this if you want to make an element which inserts some pre-prepared attributes into the element.

Term Text Attribute | Some terms (like |

(Monad m, (~) * f (HtmlT m a)) => Term [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |

Monad m => Term (HtmlT m a) (HtmlT m a) | Given children immediately, just use that and expect no attributes. |

class TermRaw arg result | result -> arg where Source

Same as the `Term`

class, but will not HTML escape its
children. Useful for elements like `style_`

or
`script_`

.

:: Text | Name of the element or attribute. |

-> arg | Either an attribute list or children. |

-> result | Result: either an element or an attribute. |

Used for constructing elements e.g. `termRaw "p"`

yields `p_`

.

:: Text | Name. |

-> [Attribute] | Attribute transformer. |

-> arg | Some argument. |

-> result | Result: either an element or an attribute. |

Use this if you want to make an element which inserts some pre-prepared attributes into the element.

TermRaw Text Attribute | Some termRaws (like |

(Monad m, (~) * a ()) => TermRaw Text (HtmlT m a) | Given children immediately, just use that and expect no attributes. |

(Monad m, ToHtml f, (~) * a ()) => TermRaw [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |

Can be converted to HTML.

With an element use these attributes. An overloaded way of adding attributes either to an element accepting attributes-and-children or one that just accepts attributes. See the two instances.

:: a | Some element, either |

-> [Attribute] | |

-> a |

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