lucid

Clear to write, read and edit DSL for HTML

Version on this page:	2.9.6
LTS Haskell 22.41:	2.11.20230408@rev:2
Stackage Nightly 2024-11-12:	2.11.20230408@rev:2
Latest on Hackage:	2.11.20230408@rev:2

See all snapshots lucid appears in

BSD-3-Clause licensed by Chris Done

Maintained by [email protected]

This version can be pinned in stack with:lucid-2.9.6@sha256:8a8c51ef0b1bd2be73bd48a57dd9cccc624ccebe8adbe9530b77f0ca82b14794,1900

Module documentation for 2.9.6

Lucid

Depends on 10 packages(full list with versions):

base, blaze-builder, bytestring, containers, hashable, mmorph, mtl, text, transformers, unordered-containers

Used by 9 packages in lts-6.19(full list with versions):

cheapskate-lucid, digestive-functors-lucid, lucid-svg, markup, servant-lucid, Spock-lucid, stackage-curator, wai-middleware-content-type, webpage

lucid

Clear to write, read and edit DSL for writing HTML

Documentation

Introduction

HTML terms in Lucid are written with a postfix ‘_’ to indicate data rather than code. Some examples:

p_, class_, table_, style_

See Lucid.Html5 for a complete list of Html5 combinators.

Plain text is written using the OverloadedStrings and ExtendedDefaultRules extensions, and is automatically escaped:

λ> "123 < 456" :: Html ()

123 &lt; 456

Elements nest by function application:

λ> table_ (tr_ (td_ (p_ "Hello, World!"))) :: Html ()

<table><tr><td><p>Hello, World!</p></td></tr></table>

Elements are juxtaposed via monoidal append:

λ> p_ "hello" <> p_ "sup" :: Html ()

<p>hello</p><p>sup</p>

Or monadic sequencing:

λ> div_ (do p_ "hello"; p_ "sup") :: Html ()

<div><p>hello</p><p>sup</p></div>

Attributes are set by providing an argument list:

λ> p_ [class_ "brand"] "Lucid Inc" :: Html ()

<p class="brand">Lucid Inc</p>

Here is a fuller example of Lucid:

table_ [rows_ "2"]
       (tr_ (do td_ [class_ "top",colspan_ "2",style_ "color:red"]
                    (p_ "Hello, attributes!")
                td_ "yay!"))

<table rows="2">
  <tr>
    <td style="color:red" colspan="2" class="top">
      <p>Hello, attributes!</p>
    </td>
    <td>yay!</td>
  </tr>
</table>

Rendering

For proper rendering you can easily run some HTML immediately with:

λ> renderText (p_ "Hello!")

"<p>Hello!</p>"

Or to bytes:

λ> renderBS (p_ [style_ "color:red"] "Hello!")

"<p style=\"color:red\">Hello!</p>"

For ease of use in GHCi, there is a Show instance, as demonstrated above.

If the above rendering functions aren’t suited for your purpose, you can run the monad directly via execHtml and use the more low-level blaze Builder, which has a plethora of output modes in Blaze.ByteString.Builder.

See the documentation for the Lucid module for information about using it as a monad transformer.

Transforming

You can use lift to call parent monads.

λ> runReader (renderTextT (html_ (body_ (do name <- lift ask
                                            p_ [class_ "name"] (toHtml name)))))
             ("Chris" :: String)

"<html><body><p class=\"name\">Chris</p></body></html>"

Changes

2.9.6

Fix compilation of benchmarks
Add @athanclark’s version of relaxHtmlT
Add a utility to generalize the underlying monad from Identity

2.9.5

Add ToHtml instance for ByteString (both)

2.9.1

Small performance tweaks.
Make svg_ an element.

2.6

Restrict monoid instance’s a to ~ () (means you can use mempty without inference errors)

2.2

Export renderToFile from top-level Lucid module.

2.1

Add some extra HTML tags.

2.0

Use variadic HTML terms.
Add lazy Text instance for ToHtml.

1.0

Initial version.