Text.Blaze

Contents

Description

Core exposed functions.

Synopsis

Important types.

The core HTML datatype.

Instances

Monad Html
IsString (Html a)
Monoid (Html a)
Attributable (Html a)
Attributable (Html a -> Html b)

data Tag Source

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

Instances

IsString Tag
Monoid Tag

data Attribute Source

Type for an attribute.

data AttributeValue Source

The type for the value part of an attribute.

Instances

IsString AttributeValue
Monoid AttributeValue

Creating attributes.

dataAttribute Source

Arguments

:: Tag	Name of the attribute.
-> AttributeValue	Value for the attribute.
-> Attribute	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 BlazeHtml using this funcion. The above fragment could be described using BlazeHtml with:

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

Converting values to HTML.

text Source

Arguments

:: Text	Text to render.
-> Html a	Resulting HTML fragment.

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

preEscapedText Source

Arguments

:: Text	Text to insert.
-> Html a

Render text without escaping.

string Source

Arguments

:: String	String to insert.
-> Html a	Resulting HTML fragment.

Create an HTML snippet from a String.

preEscapedString :: String -> Html aSource

Create an HTML snippet from a String without escaping

showHtml Source

Arguments

:: Show a
=> a	Value to insert.
-> Html b	Resulting HTML fragment.

Create an HTML snippet from a datatype that instantiates Show.

preEscapedShowHtml Source

Arguments

:: Show a
=> a	Value to insert.
-> Html b	Resulting HTML fragment.

Create an HTML snippet from a datatype that instantiates Show. This function will not do any HTML entity escaping.

Inserting literal ByteString's.

unsafeByteString Source

Arguments

:: ByteString	Value to insert.
-> Html a	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).

Creating tags.

textTag Source

Arguments

:: Text	`Text` for the tag.
-> Tag	Resulting tag.

Create a tag from a Text value. A tag is a string used to denote a certain HTML element, for example img.

This is only useful if you want to create custom HTML combinators.

stringTag Source

Arguments

:: String	`String` for the tag.
-> Tag	Resulting tag.

Create a tag from a String value. For more information, see textTag.

Converting values to attribute values.

textValue Source

Arguments

:: Text	The actual value.
-> AttributeValue	Resulting attribute value.

Render an attribute value from Text.

preEscapedTextValue Source

Arguments

:: Text	Text to insert.
-> AttributeValue

Render an attribute value from Text without escaping.

stringValue :: String -> AttributeValue Source

Create an attribute value from a String.

preEscapedStringValue :: String -> AttributeValue Source

Create an attribute value from a String without escaping.

Setting attributes

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

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>

Rendering HTML.

renderHtml Source

Arguments

:: Html a	Document to render.
-> ByteString	Resulting output.

O(n). Render the HTML fragment to lazy ByteString.