mdgriffith/style-elements/3.4.0

NOTE: this package is not compatible with Elm 0.19.1

Element.Attributes

This module is a mirror of Html.Attributes

Some attributes have been added.

The only modification to the existing library is that style has been renamed inlineStyle to avoid collision with Style.style.

Since this is a style library, you shouldn't need it very often.

Style Element Attributes

These are the new attributes that generally have to do with layout.

hidden : Attribute variation msg

Remove the element from the view.

vary : variation -> Bool -> Attribute variation msg

Apply a style variation.

el MyButton [ vary Disabled True ] (text "My Disabled Button!")

Alignment

Alignment attributes are incredibly useful for adjusting your layout.

When applied to layout elements like row and grid, alignment will affect the alignment of the children.

When applied to singular elements like el, alignment will affect the alignment of that individual element.

center : Attribute variation msg
verticalCenter : Attribute variation msg
justify : Attribute variation msg
alignTop : Attribute variation msg
alignBottom : Attribute variation msg
alignLeft : Attribute variation msg
alignRight : Attribute variation msg

Sizing

width : Length -> Attribute variation msg
minWidth : Length -> Attribute variation msg
maxWidth : Length -> Attribute variation msg
height : Length -> Attribute variation msg
minHeight : Length -> Attribute variation msg
maxHeight : Length -> Attribute variation msg
type alias Length =
Length
px : Float -> Length
fill : Float -> Length
percent : Float -> Length

Spacing ++ Padding

Spacing allows a layout to set the distance between the children in the layout.

So this layout:

row [ spacing 10, padding 10 ]
    [ el Box [] empty
    , el Box [] empty
    , el Box [] empty
    ]

Is rendered into something like this:

Spacing
spacing : Float -> Attribute variation msg

Set the spacing between children in a layout.

spacingXY : Float -> Float -> Attribute variation msg

Set the horizontal and vertical spacing separately.

This is generally only useful in a textLayout or a grid.

padding : Float -> Attribute variation msg
paddingXY : Float -> Float -> Attribute variation msg

Set horizontal and vertical padding.

paddingTop : Float -> Attribute variation msg
paddingRight : Float -> Attribute variation msg
paddingBottom : Float -> Attribute variation msg
paddingLeft : Float -> Attribute variation msg

Positioning

moveUp : Float -> Attribute variation msg
moveDown : Float -> Attribute variation msg
moveRight : Float -> Attribute variation msg
moveLeft : Float -> Attribute variation msg
moveXY : Float -> Float -> Attribute variation msg

Adjust the position of the element.

moveX : Float -> Attribute variation msg
moveY : Float -> Attribute variation msg

Scrollbars

scrollbars : Attribute variation msg

Turn on scrollbars if content overflows.

yScrollbar : Attribute variation msg

Turn on scrollbars if content overflows vertically.

xScrollbar : Attribute variation msg

Turn on scrollbars if content overflows horizontally.

Overflow

clip : Attribute variation msg

Clip content that overflows.

clipX : Attribute variation msg
clipY : Attribute variation msg

Conversion

toAttr : Attribute msg -> Attribute variation msg

Convert an existing Html.Attribute to an Element.Attribute.

This is useful for working with any library that returns a Html.Attribute.

Normal Html.Attributes

Helper functions for HTML attributes. They are organized roughly by category. Each attribute is labeled with the HTML tags it can be used with, so just search the page for video if you want video stuff.

If you cannot find what you are looking for, go to the Custom Attributes section to learn how to create new helpers.

Primitives

inlineStyle : List ( String, String ) -> Attribute variation msg

Specify a list of styles.

myStyle : Attribute msg
myStyle =
    inlineStyle
        [ ( "backgroundColor", "red" )
        , ( "height", "90px" )
        , ( "width", "100%" )
        ]


greeting : Html msg
greeting =
    div [ myStyle ] [ text "Hello!" ]

There is no Html.Styles module because best practices for working with HTML suggest that this should primarily be specified in CSS files. So the general recommendation is to use this function lightly.

property : String -> Value -> Attribute variation msg

Create properties, like saying domNode.className = 'greeting' in JavaScript.

import Json.Encode as Encode


class : String -> Attribute variation msg
class =
    Html.Attributes.class

Read more about the difference between properties and attributes here.

attribute : String -> String -> Attribute variation msg

Create attributes, like saying domNode.setAttribute('class', 'greeting') in JavaScript.

class : String -> Attribute variation msg
class =
    Html.Attributes.class

Read more about the difference between properties and attributes here.

map : (a -> msg) -> Attribute variation a -> Attribute variation msg

Transform the messages produced by an Attribute.

Super Common Attributes

class : String -> Attribute variation msg

Often used with CSS to style elements with common properties.

classList : List ( String, Bool ) -> Attribute variation msg

This function makes it easier to build a space-separated class attribute. Each class can easily be added and removed depending on the boolean value it is paired with. For example, maybe we want a way to view notices:

viewNotice : Notice -> Html msg
viewNotice notice =
    div
        [ classList
            [ ( "notice", True )
            , ( "notice-important", notice.isImportant )
            , ( "notice-seen", notice.isSeen )
            ]
        ]
        [ text notice.content ]
id : String -> Attribute variation msg

Often used with CSS to style a specific element. The value of this attribute must be unique.

title : String -> Attribute variation msg

Text to be displayed in a tooltip when hovering over the element.

hidden : Attribute variation msg

Remove the element from the view.

Inputs

type_ : String -> Attribute variation msg

Defines the type of a button, input, embed, object, script, source, style, or menu.

value : String -> Attribute variation msg

Defines a default value which will be displayed in a button, option, input, li, meter, progress, or param.

defaultValue : String -> Attribute variation msg

Defines an initial value which will be displayed in an input when that input is added to the DOM. Unlike value, altering defaultValue after the input element has been added to the DOM has no effect.

checked : Bool -> Attribute variation msg

Indicates whether an input of type checkbox is checked.

placeholder : String -> Attribute variation msg

Provides a hint to the user of what can be entered into an input or textarea.

selected : Bool -> Attribute variation msg

Defines which option will be selected on page load.

Input Helpers

accept : String -> Attribute variation msg

List of types the server accepts, typically a file type. For form and input.

acceptCharset : String -> Attribute variation msg

List of supported charsets in a form.

action : String -> Attribute variation msg

The URI of a program that processes the information submitted via a form.

autocomplete : Bool -> Attribute variation msg

Indicates whether a form or an input can have their values automatically completed by the browser.

autofocus : Bool -> Attribute variation msg

The element should be automatically focused after the page loaded. For button, input, keygen, select, and textarea.

disabled : Bool -> Attribute variation msg

Indicates whether the user can interact with a button, fieldset, input, keygen, optgroup, option, select or textarea.

enctype : String -> Attribute variation msg

How form data should be encoded when submitted with the POST method. Options include: application/x-www-form-urlencoded, multipart/form-data, and text/plain.

formaction : String -> Attribute variation msg

Indicates the action of an input or button. This overrides the action defined in the surrounding form.

list : String -> Attribute variation msg

Associates an input with a datalist tag. The datalist gives some pre-defined options to suggest to the user as they interact with an input. The value of the list attribute must match the id of a datalist node. For input.

maxlength : Int -> Attribute variation msg

Defines the maximum number of characters allowed in an input or textarea.

minlength : Int -> Attribute variation msg

Defines the minimum number of characters allowed in an input or textarea.

method : String -> Attribute variation msg

Defines which HTTP method to use when submitting a form. Can be GET (default) or POST.

multiple : Bool -> Attribute variation msg

Indicates whether multiple values can be entered in an input of type email or file. Can also indicate that you can select many options.

name : String -> Attribute variation msg

Name of the element. For example used by the server to identify the fields in form submits. For button, form, fieldset, iframe, input, keygen, object, output, select, textarea, map, meta, and param.

novalidate : Bool -> Attribute variation msg

This attribute indicates that a form shouldn't be validated when submitted.

pattern : String -> Attribute variation msg

Defines a regular expression which an input's value will be validated against.

readonly : Bool -> Attribute variation msg

Indicates whether an input or textarea can be edited.

required : Bool -> Attribute variation msg

Indicates whether this element is required to fill out or not. For input, select, and textarea.

size : Int -> Attribute variation msg

For input specifies the width of an input in characters.

For select specifies the number of visible options in a drop-down list.

for : String -> Attribute variation msg

The element ID described by this label or the element IDs that are used for an output.

form : String -> Attribute variation msg

Indicates the element ID of the form that owns this particular button, fieldset, input, keygen, label, meter, object, output, progress, select, or textarea.

Input Ranges

max : String -> Attribute variation msg

Indicates the maximum value allowed. When using an input of type number or date, the max value must be a number or date. For input, meter, and progress.

min : String -> Attribute variation msg

Indicates the minimum value allowed. When using an input of type number or date, the min value must be a number or date. For input and meter.

step : String -> Attribute variation msg

Add a step size to an input. Use step "any" to allow any floating-point number to be used in the input.

Input Text Areas

cols : Int -> Attribute variation msg

Defines the number of columns in a textarea.

rows : Int -> Attribute variation msg

Defines the number of rows in a textarea.

wrap : String -> Attribute variation msg

Indicates whether the text should be wrapped in a textarea. Possible values are "hard" and "soft".

Links and Areas

href : String -> Attribute variation msg

The URL of a linked resource, such as a, area, base, or link.

target : String -> Attribute variation msg

Specify where the results of clicking an a, area, base, or form should appear. Possible special values include:

  • _blank — a new window or tab
  • _self — the same frame (this is default)
  • _parent — the parent frame
  • _top — the full body of the window

You can also give the name of any frame you have created.

download : Bool -> Attribute variation msg

Indicates that clicking an a and area will download the resource directly.

downloadAs : String -> Attribute variation msg

Indicates that clicking an a and area will download the resource directly, and that the downloaded resource with have the given filename.

hreflang : String -> Attribute variation msg

Two-letter language code of the linked resource of an a, area, or link.

media : String -> Attribute variation msg

Specifies a hint of the target media of a a, area, link, source, or style.

ping : String -> Attribute variation msg

Specify a URL to send a short POST request to when the user clicks on an a or area. Useful for monitoring and tracking.

rel : String -> Attribute variation msg

Specifies the relationship of the target object to the link object. For a, area, link.

Maps

ismap : Bool -> Attribute variation msg

When an img is a descendent of an a tag, the ismap attribute indicates that the click location should be added to the parent a's href as a query string.

usemap : String -> Attribute variation msg

Specify the hash name reference of a map that should be used for an img or object. A hash name reference is a hash symbol followed by the element's name or id. E.g. "#planet-map".

shape : String -> Attribute variation msg

Declare the shape of the clickable area in an a or area. Valid values include: default, rect, circle, poly. This attribute can be paired with coords to create more particular shapes.

coords : String -> Attribute variation msg

A set of values specifying the coordinates of the hot-spot region in an area. Needs to be paired with a shape attribute to be meaningful.

Embedded Content

src : String -> Attribute variation msg

The URL of the embeddable content. For audio, embed, iframe, img, input, script, source, track, and video.

alt : String -> Attribute variation msg

Alternative text in case an image can't be displayed. Works with img, area, and input.

Audio and Video

autoplay : Bool -> Attribute variation msg

The audio or video should play as soon as possible.

controls : Bool -> Attribute variation msg

Indicates whether the browser should show playback controls for the audio or video.

loop : Bool -> Attribute variation msg

Indicates whether the audio or video should start playing from the start when it's finished.

preload : String -> Attribute variation msg

Control how much of an audio or video resource should be preloaded.

poster : String -> Attribute variation msg

A URL indicating a poster frame to show until the user plays or seeks the video.

default : Bool -> Attribute variation msg

Indicates that the track should be enabled unless the user's preferences indicate something different.

kind : String -> Attribute variation msg

Specifies the kind of text track.

srclang : String -> Attribute variation msg

A two letter language code indicating the language of the track text data.

iframes

sandbox : String -> Attribute variation msg

A space separated list of security restrictions you'd like to lift for an iframe.

seamless : Bool -> Attribute variation msg

Make an iframe look like part of the containing document.

srcdoc : String -> Attribute variation msg

An HTML document that will be displayed as the body of an iframe. It will override the content of the src attribute if it has been specified.

Ordered Lists

reversed : Bool -> Attribute variation msg

Indicates whether an ordered list ol should be displayed in a descending order instead of a ascending.

start : Int -> Attribute variation msg

Defines the first number of an ordered list if you want it to be something besides 1.

Tables

align : String -> Attribute variation msg

Specifies the horizontal alignment of a caption, col, colgroup, hr, iframe, img, table, tbody, td, tfoot, th, thead, or tr.

colspan : Int -> Attribute variation msg

The colspan attribute defines the number of columns a cell should span. For td and th.

rowspan : Int -> Attribute variation msg

Defines the number of rows a table cell should span over. For td and th.

headers : String -> Attribute variation msg

A space separated list of element IDs indicating which th elements are headers for this cell. For td and th.

scope : String -> Attribute variation msg

Specifies the scope of a header cell th. Possible values are: col, row, colgroup, rowgroup.

Header Stuff

async : Bool -> Attribute variation msg

Indicates that the script should be executed asynchronously.

charset : String -> Attribute variation msg

Declares the character encoding of the page or script. Common values include:

  • UTF-8 - Character encoding for Unicode
  • ISO-8859-1 - Character encoding for the Latin alphabet

For meta and script.

content : String -> Attribute variation msg

A value associated with http-equiv or name depending on the context. For meta.

defer : Bool -> Attribute variation msg

Indicates that a script should be executed after the page has been parsed.

httpEquiv : String -> Attribute variation msg

This attribute is an indicator that is paired with the content attribute, indicating what that content means. httpEquiv can take on three different values: content-type, default-style, or refresh. For meta.

language : String -> Attribute variation msg

Defines the script language used in a script.

scoped : Bool -> Attribute variation msg

Indicates that a style should only apply to its parent and all of the parents children.

Less Common Global Attributes

Attributes that can be attached to any HTML tag but are less commonly used.

accesskey : Char -> Attribute variation msg

Defines a keyboard shortcut to activate or add focus to the element.

contenteditable : Bool -> Attribute variation msg

Indicates whether the element's content is editable.

contextmenu : String -> Attribute variation msg

Defines the ID of a menu element which will serve as the element's context menu.

dir : String -> Attribute variation msg

Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left).

draggable : String -> Attribute variation msg

Defines whether the element can be dragged.

dropzone : String -> Attribute variation msg

Indicates that the element accept the dropping of content on it.

itemprop : String -> Attribute variation msg
lang : String -> Attribute variation msg

Defines the language used in the element.

spellcheck : Bool -> Attribute variation msg

Indicates whether spell checking is allowed for the element.

tabindex : Int -> Attribute variation msg

Overrides the browser's default tab order and follows the one specified instead.

Key Generation

challenge : String -> Attribute variation msg

A challenge string that is submitted along with the public key in a keygen.

keytype : String -> Attribute variation msg

Specifies the type of key generated by a keygen. Possible values are: rsa, dsa, and ec.

Miscellaneous

cite : String -> Attribute variation msg

Contains a URI which points to the source of the quote or change in a blockquote, del, ins, or q.

datetime : String -> Attribute variation msg

Indicates the date and time associated with the element. For del, ins, time.

pubdate : String -> Attribute variation msg

Indicates whether this date and time is the date of the nearest article ancestor element. For time.

manifest : String -> Attribute variation msg

Specifies the URL of the cache manifest for an html tag.