Html

Primitives

type alias Html msg = Node 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 = Property 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 -> List (Attribute msg) -> List (Html msg) -> Html msg
General way to create HTML nodes. It is used to define all of the helper functions in this library.

div : List (Attribute msg) -> List (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 _ =
  div []
    [ map (\_ -> Left) (viewButton "Left")
    , map (\_ -> Right) (viewButton "Right")
    ]

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

Programs

    
beginnerProgram :
  { model : model
  , view : model -> Html msg
  , update : msg -> model -> model
  } -> Program Never model msg

Create a Program that describes how your whole app works.

program :
  { init : (model, Cmd msg)
  , update : msg -> model -> (model, Cmd msg)
  , subscriptions : model -> Sub msg
  , view : model -> Html msg
  } -> Program Never model msg

Create a Program that describes how your whole app works.

programWithFlags :
  { init : flags -> (model, Cmd msg)
  , update : msg -> model -> (model, Cmd msg)
  , subscriptions : model -> Sub msg
  , view : model -> Html msg } -> Program flags model msg

It works just like program but you can provide “flags” from JavaScript to configure your application.

Tags

Headers

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

Grouping Content

div : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a generic container with no special meaning.

p : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a portion that should be displayed as a paragraph.

hr : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a thematic break between paragraphs of a section or article or any longer content.

pre : List (Attribute msg) -> List (Html msg) -> Html msg
Indicates that its content is preformatted and that this format must be preserved.

blockquote : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a content that is quoted from another source.

Text

span : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a hyperlink, linking to another resource.

code : List (Attribute msg) -> List (Html msg) -> Html msg
Represents computer code.

em : List (Attribute msg) -> List (Html msg) -> Html msg
Represents emphasized text, like a stress accent.

strong : List (Attribute msg) -> List (Html msg) -> Html msg
Represents especially important text.

i : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a non-textual annoatation for which the conventional presentation is underlining, such labeling the text as being misspelt or labeling a proper name in Chinese text.

sub : List (Attribute msg) -> List (Html msg) -> Html msg
Represent a subscript.

sup : List (Attribute msg) -> List (Html msg) -> Html msg
Represent a superscript.

br : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a line break.

Lists

ol : List (Attribute msg) -> List (Html msg) -> Html msg
Defines an ordered list of items.

ul : List (Attribute msg) -> List (Html msg) -> Html msg
Defines an unordered list of items.

li : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a item of an enumeration list.

dl : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a definition list, that is, a list of terms and their associated definitions.

dt : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a term defined by the next dd.

dd : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the definition of the terms immediately listed before it.

Emdedded Content

img : List (Attribute msg) -> List (Html msg) -> Html msg
Represents an image.

iframe : List (Attribute msg) -> List (Html msg) -> Html msg
Embedded an HTML document.

canvas : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a bitmap area for graphics rendering.

math : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a mathematical formula.

Inputs

form : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a form, consisting of controls, that can be submitted to a server for processing.

input : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a typed data field allowing the user to edit the data.

textarea : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a multiline text edit control.

button : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a button.

select : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a control allowing selection among a set of options.

option : List (Attribute msg) -> List (Html msg) -> Html msg
Represents an option in a select element or a suggestion of a datalist element.

Sections

section : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a section in a document.

nav : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a section that contains only navigation links.

article : List (Attribute msg) -> List (Html msg) -> Html msg
Defines self-contained content that could exist independently of the rest of the content.

aside : List (Attribute msg) -> List (Html msg) -> Html msg
Defines some content loosely related to the page content. If it is removed, the remaining content still makes sense.

header : List (Attribute msg) -> List (Html msg) -> Html msg
Defines the header of a page or section. It often contains a logo, the title of the web site, and a navigational table of content.

footer : List (Attribute msg) -> List (Html msg) -> Html msg
Defines the footer for a page or section. It often contains a copyright notice, some links to legal information, or addresses to give feedback.

address : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a section containing contact information.

main_ : List (Attribute msg) -> List (Html msg) -> Html msg
Defines the main or important content in the document. There is only one main element in the document.

body : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the content of an HTML document. There is only one body element in a document.

Figures

figure : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a figure illustrated as part of the document.

figcaption : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the legend of a figure.

Tables

table : List (Attribute msg) -> List (Html msg) -> Html msg
Represents data with more than one dimension.

caption : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the title of a table.

colgroup : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a set of one or more columns of a table.

col : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a column of a table.

tbody : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the block of rows that describes the concrete data of a table.

thead : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the block of rows that describes the column labels of a table.

tfoot : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the block of rows that describes the column summaries of a table.

tr : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a row of cells in a table.

td : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a data cell in a table.

th : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a header cell in a table.

Less Common Elements

fieldset : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a set of controls.

legend : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the caption for a fieldset.

label : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the caption of a form control.

datalist : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a set of predefined options for other controls.

optgroup : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a set of options, logically grouped.

keygen : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a key-pair generator control.

output : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the result of a calculation.

progress : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the completion progress of a task.

meter : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a scalar measurement (or a fractional value), within a known range.

Audio and Video

audio : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a sound or audio stream.

video : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a video, the associated audio and captions, and controls.

source : List (Attribute msg) -> List (Html msg) -> Html msg
Allows authors to specify alternative media resources for media elements like video or audio.

track : List (Attribute msg) -> List (Html msg) -> Html msg
Allows authors to specify timed text track for media elements like video or audio.

Embedded Objects

embed : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a integration point for an external, often non-HTML, application or interactive content.

object : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (Html msg) -> Html msg
Defines parameters for use by plug-ins invoked by object elements.

Text Edits

ins : List (Attribute msg) -> List (Html msg) -> Html msg
Defines an addition to the document.

del : List (Attribute msg) -> List (Html msg) -> Html msg
Defines a removal from the document.

small : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the title of a work.

dfn : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a term whose definition is contained in its nearest ancestor content.

abbr : List (Attribute msg) -> List (Html msg) -> Html msg
Represents an abbreviation or an acronym; the expansion of the abbreviation can be represented in the title attribute.

time : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a date and time value; the machine-readable equivalent can be represented in the datetime attribute.

var : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the output of a program or a computer.

kbd : List (Attribute msg) -> List (Html msg) -> Html msg
Represents user input, often from the keyboard, but not necessarily; it may represent other input, like transcribed voice commands.

s : List (Attribute msg) -> List (Html msg) -> Html msg
Represents content that is no longer accurate or relevant.

q : List (Attribute msg) -> List (Html msg) -> Html msg
Represents an inline quotation.

mark : List (Attribute msg) -> List (Html msg) -> Html msg
Represents text highlighted for reference purposes, that is for its relevance in another context.

ruby : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the text of a ruby annotation.

rp : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (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 : List (Attribute msg) -> List (Html msg) -> Html msg
Represents the directionality of its children, in order to explicitly override the Unicode bidirectional algorithm.

wbr : List (Attribute msg) -> List (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.

details : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a widget from which the user can obtain additional information or controls.

summary : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a summary, caption, or legend for a given details.

menuitem : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a command that the user can invoke.

menu : List (Attribute msg) -> List (Html msg) -> Html msg
Represents a list of commands.

 

 


Html.Keyed

A keyed node helps optimize cases where children are getting added, moved, removed, etc. Common examples include:

The user can delete items from a list.
The user can create new items in a list.
You can sort a list based on name or date or whatever.

When you use a keyed node, every child is paired with a string identifier. This makes it possible for the underlying diffing algorithm to reuse nodes more efficiently.

Keyed Nodes

node : String -> List (Attribute msg) -> List (String, Html msg) -> Html msg
Works just like Html.node, but you add a unique identifier to each child node. You want this when you have a list of nodes that is changing: adding nodes, removing nodes, etc. In these cases, the unique identifiers help make the DOM modifications more efficient.

ol : List (Attribute msg) -> List (String, Html msg) -> Html msg
ul : List (Attribute msg) -> List (String, Html msg) -> Html msg