Transmutable.Html

This file is organized roughly in order of popularity. The tags which you'd expect to use frequently will be closer to the top.

Primitives

type alias Html msg =
Html msg

The core building block used to build up HTML. Here we create an Html value with no attributes and one child:

hello : Html msg
hello =
  div [] [ text "Hello!" ]
type alias Attribute msg =
Attribute msg

Set attributes on your Html. Learn more in the Html.Attributes module.

text : String -> Html msg

Just put plain text in the DOM. It will escape the string so that it appears exactly as you specify.

text "Hello World!"
node : String -> Array (Attribute msg) -> Array (Html msg) -> Html msg

General way to create HTML nodes. It is used to define all of the helper functions in this library.

div : Array (Attribute msg) -> Array (Html msg) -> Html msg
div attributes children =
    node "div" attributes children

You can use this to create custom nodes if you need to create something that is not covered by the helper functions in this library.

map : (a -> msg) -> Html a -> Html msg

Transform the messages produced by some Html. In the following example, we have viewButton that produces () messages, and we transform those values into Msg values in view.

type Msg = Left | Right

view : model -> Html Msg
view model =
  div []
    [ map (\_ -> Left) (viewButton "Left")
    , map (\_ -> Right) (viewButton "Right")
    ]

viewButton : String -> Html ()
viewButton name =
  button [ onClick () ] [ text name ]

If you are growing your project as recommended in the official guide, this should not come in handy in most projects. Usually it is easier to just pass things in as arguments.

Note: Some folks have tried to use this to make “components” in their projects, but they run into the fact that components are objects. Both are local mutable state with methods. Gren is not an object-oriented language, so you run into all sorts of friction if you try to use it like one. I definitely recommend against going down that path! Instead, make the simplest function possible and repeat.

Transmutions

toString : Html msg -> String

Encode the HTML as a string.

The DOCTYPE is inserted automatically when using the <html> element. No indentation or special line breaks.

toStringWithIndent : Int -> Html msg -> String

Encode the HTML as a string.

The DOCTYPE is inserted automatically when using the <html> element.

Tags

Headers

h1 : Array (Attribute msg) -> Array (Html msg) -> Html msg
h2 : Array (Attribute msg) -> Array (Html msg) -> Html msg
h3 : Array (Attribute msg) -> Array (Html msg) -> Html msg
h4 : Array (Attribute msg) -> Array (Html msg) -> Html msg
h5 : Array (Attribute msg) -> Array (Html msg) -> Html msg
h6 : Array (Attribute msg) -> Array (Html msg) -> Html msg

Grouping Content

div : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a generic container with no special meaning.

p : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines a portion that should be displayed as a paragraph.

hr : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a thematic break between paragraphs of a section or article or any longer content.

pre : Array (Attribute msg) -> Array (Html msg) -> Html msg

Indicates that its content is preformatted and that this format must be preserved.

blockquote : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a content that is quoted from another source.

Text

span : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents text with no specific meaning. This has to be used when no other text-semantic element conveys an adequate meaning, which, in this case, is often brought by global attributes like class, lang, or dir.

a : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a hyperlink, linking to another resource.

code : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents computer code.

em : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents emphasized text, like a stress accent.

strong : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents especially important text.

i : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents some text in an alternate voice or mood, or at least of different quality, such as a taxonomic designation, a technical term, an idiomatic phrase, a thought, or a ship name.

b : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a text which to which attention is drawn for utilitarian purposes. It doesn't convey extra importance and doesn't imply an alternate voice.

u : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a non-textual annotation for which the conventional presentation is underlining, such labeling the text as being misspelt or labeling a proper name in Chinese text.

sub : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represent a subscript.

sup : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represent a superscript.

br : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a line break.

Lists

ol : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines an ordered list of items.

ul : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines an unordered list of items.

li : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines a item of an enumeration list.

dl : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines a definition list, that is, a list of terms and their associated definitions.

dt : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a term defined by the next dd.

dd : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the definition of the terms immediately listed before it.

Embedded Content

img : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents an image.

iframe : Array (Attribute msg) -> Array (Html msg) -> Html msg

Embedded an HTML document.

canvas : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a bitmap area for graphics rendering.

math : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines a mathematical formula.

Inputs

form : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a form, consisting of controls, that can be submitted to a server for processing.

input : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a typed data field allowing the user to edit the data.

textarea : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a multiline text edit control.

button : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a button.

select : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a control allowing selection among a set of options.

option : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents an option in a select element or a suggestion of a datalist element.

Sections

section : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines a section in a document.

article : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines self-contained content that could exist independently of the rest of the content.

aside : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines some content loosely related to the page content. If it is removed, the remaining content still makes sense.

address : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines a section containing contact information.

main_ : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines the main or important content in the document. There is only one main element in the document.

Figures

figure : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a figure illustrated as part of the document.

figcaption : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the legend of a figure.

Tables

table : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents data with more than one dimension.

caption : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the title of a table.

colgroup : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a set of one or more columns of a table.

col : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a column of a table.

tbody : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the block of rows that describes the concrete data of a table.

thead : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the block of rows that describes the column labels of a table.

tfoot : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the block of rows that describes the column summaries of a table.

tr : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a row of cells in a table.

td : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a data cell in a table.

th : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a header cell in a table.

Less Common Elements

Less Common Inputs

fieldset : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a set of controls.

legend : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the caption for a fieldset.

label : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the caption of a form control.

datalist : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a set of predefined options for other controls.

optgroup : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a set of options, logically grouped.

output : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the result of a calculation.

progress : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the completion progress of a task.

meter : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a scalar measurement (or a fractional value), within a known range.

Audio and Video

audio : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a sound or audio stream.

video : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a video, the associated audio and captions, and controls.

source : Array (Attribute msg) -> Array (Html msg) -> Html msg

Allows authors to specify alternative media resources for media elements like video or audio.

track : Array (Attribute msg) -> Array (Html msg) -> Html msg

Allows authors to specify timed text track for media elements like video or audio.

Embedded Objects

embed : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a integration point for an external, often non-HTML, application or interactive content.

object : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents an external resource, which is treated as an image, an HTML sub-document, or an external resource to be processed by a plug-in.

param : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines parameters for use by plug-ins invoked by object elements.

Text Edits

ins : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines an addition to the document.

del : Array (Attribute msg) -> Array (Html msg) -> Html msg

Defines a removal from the document.

Semantic Text

small : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a side comment, that is, text like a disclaimer or a copyright, which is not essential to the comprehension of the document.

cite : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the title of a work.

dfn : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a term whose definition is contained in its nearest ancestor content.

abbr : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents an abbreviation or an acronym; the expansion of the abbreviation can be represented in the title attribute.

time : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a date and time value; the machine-readable equivalent can be represented in the datetime attribute.

var : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a variable. Specific cases where it should be used include an actual mathematical expression or programming context, an identifier representing a constant, a symbol identifying a physical quantity, a function parameter, or a mere placeholder in prose.

samp : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the output of a program or a computer.

kbd : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents user input, often from the keyboard, but not necessarily; it may represent other input, like transcribed voice commands.

s : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents content that is no longer accurate or relevant.

q : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents an inline quotation.

Less Common Text Tags

mark : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents text highlighted for reference purposes, that is for its relevance in another context.

ruby : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents content to be marked with ruby annotations, short runs of text presented alongside the text. This is often used in conjunction with East Asian language where the annotations act as a guide for pronunciation, like the Japanese furigana.

rt : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the text of a ruby annotation.

rp : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents parenthesis around a ruby annotation, used to display the annotation in an alternate way by browsers not supporting the standard display for annotations.

bdi : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents text that must be isolated from its surrounding for bidirectional text formatting. It allows embedding a span of text with a different, or unknown, directionality.

bdo : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents the directionality of its children, in order to explicitly override the Unicode bidirectional algorithm.

wbr : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a line break opportunity, that is a suggested point for wrapping text in order to improve readability of text split on several lines.

Interactive Elements

details : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a widget from which the user can obtain additional information or controls.

summary : Array (Attribute msg) -> Array (Html msg) -> Html msg

Represents a summary, caption, or legend for a given details.

Core elements

html : Array (Attribute msg) -> Array (Html msg) -> Html msg

The root HTML node.

body : Array (Attribute msg) -> Array (Html msg) -> Html msg

The body node that lives under <html>.

Head elements

title : Array (Html msg) -> Html msg

The document title.

meta : Array (Attribute msg) -> Html msg

Attach metadata to the HTML document.