|
|
|
|
|
Description |
The BlazeHtml core, consisting of functions that offer the power to
generate custom HTML elements. It also offers user-centric functions, which
are exposed through Text.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.
|
|
Synopsis |
|
|
|
|
Important types.
|
|
|
A string denoting input from different string representations.
| Constructors | | Instances | |
|
|
|
A static string that supports efficient output to all possible backends.
| Constructors | StaticString | | getString :: String -> String | Appending haskell string
| getUtf8ByteString :: ByteString | UTF-8 encoded bytestring
| getText :: Text | Text value
|
|
| Instances | |
|
|
|
The core HTML datatype.
| Constructors | | Instances | |
|
|
|
Simplification of the HtmlM datatype.
|
|
|
Type for an HTML tag. This can be seen as an internal string type used by
BlazeHtml.
| Instances | |
|
|
|
|
|
|
The type for the value part of an attribute.
| Instances | |
|
|
Creating custom tags and attributes.
|
|
|
:: Tag | Raw key
| -> Tag | Shared key string for the HTML attribute.
| -> AttributeValue | Value for the HTML attribute.
| -> Attribute | Resulting HTML attribute.
| Create an HTML attribute that can be applied to an HTML element later using
the ! operator.
|
|
|
|
:: 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."
|
|
|
|
:: Tag | Name of the attribute
| -> AttributeValue | Value for the attribute
| -> Attribute | 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 HTML.
|
|
|
:: Text | Text to render.
| -> Html | Resulting HTML fragment.
| Render text. Functions like these can be used to supply content in HTML.
|
|
|
|
:: Text | Text to insert
| -> Html | Resulting HTML fragment
| Render text without escaping.
|
|
|
|
:: Text | Text to insert
| -> Html | Resulting HTML fragment
| A variant of text for lazy Text.
|
|
|
|
|
|
|
:: String | String to insert.
| -> Html | Resulting HTML fragment.
| Create an HTML snippet from a String.
|
|
|
|
:: String | String to insert.
| -> Html | Resulting HTML fragment.
| Create an HTML snippet from a String without escaping
|
|
|
|
:: ByteString | Value to insert.
| -> Html | 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).
|
|
|
|
|
|
Converting values to tags.
|
|
|
:: Text | Text to create a tag from
| -> Tag | Resulting tag
| Create a Tag from some Text.
|
|
|
|
|
|
Converting values to attribute values.
|
|
|
|
|
|
:: Text | The actual value
| -> AttributeValue | Resulting attribute value
| Render an attribute value from Text without escaping.
|
|
|
|
|
|
|
|
|
|
Create an attribute value from a String.
|
|
|
Create an attribute value from a String without escaping.
|
|
|
|
|
unsafeLazyByteStringValue | Source |
|
|
|
Setting attributes
|
|
|
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>
|
|
Modifying HTML elements
|
|
|
Mark HTML as external data. External data can be:
This function is applied automatically when using the style or script
combinators.
|
|
Produced by Haddock version 2.6.1 |