Text.Blaze.Front.Internal

The BlazeMarkup core, consisting of functions that offer the power to generate custom markup elements. It also offers user-centric functions, which are exposed through Blaze.

While this module is exported, usage of it is not recommended, unless you know what you are doing. This module might undergo changes at any time.

Important types.

data ChoiceString

Constructors

Static !StaticString

String String

Text Text

ByteString ByteString

PreEscaped ChoiceString

External ChoiceString

AppendChoiceString ChoiceString ChoiceString

EmptyChoiceString

Instances

IsString ChoiceString

Methods

fromString :: String -> ChoiceString

Semigroup ChoiceString

Methods

(<>) :: ChoiceString -> ChoiceString -> ChoiceString

sconcat :: NonEmpty ChoiceString -> ChoiceString

stimes :: Integral b => b -> ChoiceString -> ChoiceString

Monoid ChoiceString

Methods

mempty :: ChoiceString

mappend :: ChoiceString -> ChoiceString -> ChoiceString

mconcat :: [ChoiceString] -> ChoiceString

data StaticString

Constructors

StaticString

Fields

• getString :: String -> String
• getUtf8ByteString :: ByteString
• getText :: Text

Instances

IsString StaticString

Methods

fromString :: String -> StaticString

data MarkupM act a

The core Markup datatype. The ev type-parameter tracks the type of events that can be raised when this Markup is rendered.

Constructors

MapActions (act' -> act) (MarkupM act' a)

Map all actions created by the inner Html.

OnEvent (EventHandler act) (MarkupM act a)

Install event handlers for the given event on all immediate children.

Parent StaticString StaticString StaticString (MarkupM act a)

Tag, open tag, end tag, content

CustomParent ChoiceString (MarkupM act a)

Custom parent

Leaf StaticString StaticString StaticString

Tag, open tag, end tag

CustomLeaf ChoiceString Bool

Custom leaf

Content ChoiceString

HTML content

Append (MarkupM act b) (MarkupM act c)

Concatenation of two HTML pieces

AddAttribute StaticString StaticString ChoiceString (MarkupM act a)

Add an attribute to the inner HTML. Raw key, key, value, HTML to receive the attribute.

AddCustomAttribute ChoiceString ChoiceString (MarkupM act a)

Add a custom attribute to the inner HTML.

Empty

Empty HTML.

Instances

Monad (MarkupM ev)

Methods

(>>=) :: MarkupM ev a -> (a -> MarkupM ev b) -> MarkupM ev b

(>>) :: MarkupM ev a -> MarkupM ev b -> MarkupM ev b

return :: a -> MarkupM ev a

fail :: String -> MarkupM ev a

Functor (MarkupM ev)

Methods

fmap :: (a -> b) -> MarkupM ev a -> MarkupM ev b

(<$) :: a -> MarkupM ev b -> MarkupM ev a

Applicative (MarkupM ev)

Methods

pure :: a -> MarkupM ev a

(<*>) :: MarkupM ev (a -> b) -> MarkupM ev a -> MarkupM ev b

liftA2 :: (a -> b -> c) -> MarkupM ev a -> MarkupM ev b -> MarkupM ev c

(*>) :: MarkupM ev a -> MarkupM ev b -> MarkupM ev b

(<*) :: MarkupM ev a -> MarkupM ev b -> MarkupM ev a

IsString (MarkupM ev a)

Methods

fromString :: String -> MarkupM ev a

Semigroup a => Semigroup (MarkupM ev a)

Methods

(<>) :: MarkupM ev a -> MarkupM ev a -> MarkupM ev a

sconcat :: NonEmpty (MarkupM ev a) -> MarkupM ev a

stimes :: Integral b => b -> MarkupM ev a -> MarkupM ev a

Monoid a => Monoid (MarkupM ev a)

Methods

mempty :: MarkupM ev a

mappend :: MarkupM ev a -> MarkupM ev a -> MarkupM ev a

mconcat :: [MarkupM ev a] -> MarkupM ev a

Attributable (MarkupM ev a -> MarkupM ev b) ev

Methods

(!) :: (MarkupM ev a -> MarkupM ev b) -> Attribute ev -> MarkupM ev a -> MarkupM ev b

Attributable (MarkupM ev a) ev

Methods

(!) :: MarkupM ev a -> Attribute ev -> MarkupM ev a

type Markup e = MarkupM e ()

Simplification of the MarkupM datatype.

data Tag

Type for an HTML tag. This can be seen as an internal string type used by BlazeMarkup.

Instances

IsString Tag

Methods

fromString :: String -> Tag

newtype Attribute ev

Type for an attribute.

Constructors

Attribute (forall a. MarkupM ev a -> MarkupM ev a)

Instances

Semigroup (Attribute ev)

Methods

(<>) :: Attribute ev -> Attribute ev -> Attribute ev

sconcat :: NonEmpty (Attribute ev) -> Attribute ev

stimes :: Integral b => b -> Attribute ev -> Attribute ev

Monoid (Attribute ev)

Methods

mempty :: Attribute ev

mappend :: Attribute ev -> Attribute ev -> Attribute ev

mconcat :: [Attribute ev] -> Attribute ev

newtype AttributeValue

The type for the value part of an attribute.

Constructors

AttributeValue

Fields

• unAttributeValue :: ChoiceString

Instances

IsString AttributeValue

Methods

fromString :: String -> AttributeValue

Semigroup AttributeValue

Methods

(<>) :: AttributeValue -> AttributeValue -> AttributeValue

sconcat :: NonEmpty AttributeValue -> AttributeValue

stimes :: Integral b => b -> AttributeValue -> AttributeValue

Monoid AttributeValue

Methods

mempty :: AttributeValue

mappend :: AttributeValue -> AttributeValue -> AttributeValue

mconcat :: [AttributeValue] -> AttributeValue

ToValue AttributeValue

Methods

toValue :: AttributeValue -> AttributeValue

preEscapedToValue :: AttributeValue -> AttributeValue

Creating custom tags and attributes.

customParent

Arguments

:: Tag

Element tag

-> Markup ev

Content

-> Markup ev

Resulting markup

Create a custom parent element

customLeaf

Arguments

:: Tag

Element tag

-> Bool

Close the leaf?

-> Markup ev

Resulting markup

Create a custom leaf element

attribute

Arguments

:: Tag

Raw key

-> Tag

Shared key string for the HTML attribute.

-> AttributeValue

Value for the HTML attribute.

-> Attribute ev

Resulting HTML attribute.

Create an HTML attribute that can be applied to an HTML element later using the ! operator.

dataAttribute

Arguments

:: Tag

Name of the attribute.

-> AttributeValue

Value for the attribute.

-> Attribute ev

Resulting HTML attribute.

From HTML 5 onwards, the user is able to specify custom data attributes.

An example:

<p data-foo="bar">Hello.</p>

We support this in BlazeMarkup using this funcion. The above fragment could be described using BlazeMarkup with:

p ! dataAttribute "foo" "bar" $ "Hello."

customAttribute

Arguments

:: Tag

Name of the attribute

-> AttributeValue

Value for the attribute

-> Attribute ev

Resulting HTML attribtue

Create a custom attribute. This is not specified in the HTML spec, but some JavaScript libraries rely on it.

An example:

<select dojoType="select">foo</select>

Can be produced using:

select ! customAttribute "dojoType" "select" $ "foo"

Converting values to Markup.

text

Arguments

:: Text

Text to render.

-> Markup ev

Resulting HTML fragment.

Render text. Functions like these can be used to supply content in HTML.

preEscapedText

Arguments

:: Text

Text to insert

-> Markup ev

Resulting HTML fragment

Render text without escaping.

lazyText

Arguments

:: Text

Text to insert

-> Markup ev

Resulting HTML fragment

A variant of text for lazy Text.

preEscapedLazyText

Arguments

:: Text

Text to insert

-> Markup ev

Resulting HTML fragment

A variant of preEscapedText for lazy Text

string

Arguments

:: String

String to insert.

-> Markup ev

Resulting HTML fragment.

Create an HTML snippet from a String.

preEscapedString

Arguments

:: String

String to insert.

-> Markup ev

Resulting HTML fragment.

Create an HTML snippet from a String without escaping

unsafeByteString

Arguments

:: ByteString

Value to insert.

-> Markup ev

Resulting HTML fragment.

Insert a ByteString. This is an unsafe operation:

• The ByteString could have the wrong encoding.
• The ByteString might contain illegal HTML characters (no escaping is done).

unsafeLazyByteString

Arguments

:: ByteString

Value to insert

-> Markup ev

Resulting HTML fragment

Insert a lazy ByteString. See unsafeByteString for reasons why this is an unsafe operation.

Converting values to tags.

textTag

Arguments

:: Text

Text to create a tag from

-> Tag

Resulting tag

Create a Tag from some Text.

stringTag

Arguments

:: String

String to create a tag from

-> Tag

Resulting tag

Create a Tag from a String.

Converting values to attribute values.

textValue

Arguments

:: Text

The actual value.

-> AttributeValue

Resulting attribute value.

Render an attribute value from Text.

preEscapedTextValue

Arguments

:: Text

The actual value

-> AttributeValue

Resulting attribute value

Render an attribute value from Text without escaping.

lazyTextValue

Arguments

:: Text

The actual value

-> AttributeValue

Resulting attribute value

A variant of textValue for lazy Text

preEscapedLazyTextValue

Arguments

:: Text

The actual value

-> AttributeValue

Resulting attribute value

A variant of preEscapedTextValue for lazy Text

stringValue :: String -> AttributeValue

Create an attribute value from a String.

preEscapedStringValue :: String -> AttributeValue

Create an attribute value from a String without escaping.

unsafeByteStringValue

Arguments

:: ByteString

ByteString value

-> AttributeValue

Resulting attribute value

Create an attribute value from a ByteString. See unsafeByteString for reasons why this might not be a good idea.

unsafeLazyByteStringValue

Arguments

:: ByteString

ByteString value

-> AttributeValue

Resulting attribute value

Create an attribute value from a lazy ByteString. See unsafeByteString for reasons why this might not be a good idea.

Setting attributes

class Attributable h ev | h -> ev

Used for applying attributes. You should not define your own instances of this class.

Minimal complete definition

(!)

Instances

Attributable (MarkupM ev a -> MarkupM ev b) ev

Methods

(!) :: (MarkupM ev a -> MarkupM ev b) -> Attribute ev -> MarkupM ev a -> MarkupM ev b

Attributable (MarkupM ev a) ev

Methods

(!) :: MarkupM ev a -> Attribute ev -> MarkupM ev a

(!) :: Attributable h ev => h -> Attribute ev -> h

Apply an attribute to an element.

Example:

img ! src "foo.png"

Result:

<img src="foo.png" />

This can be used on nested elements as well.

Example:

p ! style "float: right" $ "Hello!"

Result:

<p style="float: right">Hello!</p>

(!?) :: Attributable h ev => h -> (Bool, Attribute ev) -> h

Shorthand for setting an attribute depending on a conditional.

Example:

p !? (isBig, A.class "big") $ "Hello"

Gives the same result as:

(if isBig then p ! A.class "big" else p) "Hello"

Modifying Markup elements

contents :: MarkupM ev a -> MarkupM ev' b

Take only the text content of an HTML tree.

contents $ do
    p ! $ "Hello "
    p ! $ "Word!"

Result:

Hello World!

external :: MarkupM ev a -> MarkupM ev a

Mark HTML as external data. External data can be:

• CSS data in a style tag;
• Script data in a script tag.

This function is applied automatically when using the style or script combinators.

Querying Markup elements

null :: MarkupM ev a -> Bool

Check if a Markup value is completely empty (renders to the empty string).