austinshenk/elm-w3/1.0.0

NOTE: the latest version is 4.0.0

W3.Aria

File that contains all WAI-ARIA roles as defined by W3's specification and in alphabetical order. If you want to read more about a role's purpose, take a look at the role definitions list.

Definitions

type alias Attribute a =
Attribute a

Base Type for Aria Attributes

type alias GlobalAttributes a =
Attribute
{ a
| atomic : Supported
, busy : Supported
, controls : Supported
, current : Supported
, describedby : Supported
, details : Supported
, disabled : Supported
, dropeffect : Supported
, errormessage : Supported
, flowto : Supported
, grabbed : Supported
, haspopup : Supported
, hidden : Supported
, invalid : Supported
, keyshortcuts : Supported
, label : Supported
, labelledby : Supported
, live : Supported
, owns : Supported
, relevant : Supported
, roledescription : Supported
}

Attributes that can be assigned to any Role

Roles

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of live region with important, and usually time-sensitive, information.

List
(GlobalAttributes
{ expanded : Supported
, modal : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of dialog that contains an alert message, where initial focus goes to an element within the dialog.

List (GlobalAttributes { activedescendant : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A structure containing one or more focusable elements requiring user input, such as keyboard or gesture events, that do not follow a standard interaction pattern supported by a widget role.

List
(GlobalAttributes
{ expanded : Supported
, posinset : Supported
, setsize : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A section of a page that consists of a composition that forms an independent part of a document, page, or site.

List
(GlobalAttributes
{ expanded : Supported
, pressed : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

An input that allows for user-triggered actions when clicked or pressed.

List
(GlobalAttributes
{ expanded : Supported
, colindex : Supported
, colspan : Supported
, rowindex : Supported
, rowspan : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A cell in a tabular container.

List
(GlobalAttributes
{ checked : Supported
, readonly : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A checkable input that has three possible values: true, false, or mixed.

List
(GlobalAttributes
{ colindex : Supported
, colspan : Supported
, expanded : Supported
, readonly : Supported
, required : Supported
, rowindex : Supported
, rowspan : Supported
, selected : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A cell containing header information for a column.

List
(GlobalAttributes
{ controls : Supported
, expanded : Supported
, autocomplete : Supported
, readonly : Supported
, required : Supported
, activedescendant : Supported
, orientation : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A composite widget containing a single-line textbox and another element, such as a listbox or grid, that can dynamically pop up to help the user set the value of the textbox.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A supporting section of the document, designed to be complementary to the main content at a similar level in the DOM hierarchy, but remains meaningful when separated from the main content.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A large perceivable region that contains information about the parent document.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A definition of a term or concept.

List
(GlobalAttributes
{ expanded : Supported
, modal : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A dialog is a descendant window of the primary window of a web application. For HTML pages, the primary application window is the entire web document, i.e., the body element.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A list of references to members of a group, such as a static table of contents.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

An element containing content that assistive technology users may want to browse in a reading mode.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A scrollable list of articles where scrolling may cause articles to be added to or removed from either end of the list.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A perceivable section of content that typically contains a graphical document, images, code snippets, or example text. The parts of a figure MAY be user-navigable.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A landmark region that contains a collection of items and objects that, as a whole, combine to create a form.

List
(GlobalAttributes
{ level : Supported
, multiselectable : Supported
, readonly : Supported
, activedescendant : Supported
, colcount : Supported
, expanded : Supported
, rowcount : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A composite widget containing a collection of one or more rows with one or more cells where some or all cells in the grid are focusable by using methods of two-dimensional navigation, such as directional arrow keys.

List
(GlobalAttributes
{ colindex : Supported
, colspan : Supported
, expanded : Supported
, readonly : Supported
, required : Supported
, rowindex : Supported
, rowspan : Supported
, selected : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A cell in a grid or treegrid.

List
(GlobalAttributes
{ activedescendant : Supported
, expanded : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A set of user interface objects which are not intended to be included in a page summary or table of contents by assistive technologies.

List
(GlobalAttributes
{ level : Supported
, expanded : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A heading for a section of the page.

img :
List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A container for a collection of elements that form an image.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A section containing listitem elements.

List
(GlobalAttributes
{ multiselectable : Supported
, readonly : Supported
, required : Supported
, activedescendant : Supported
, expanded : Supported
, orientation : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A widget that allows the user to select one or more items from a list of choices.

List
(GlobalAttributes
{ level : Supported
, posinset : Supported
, setsize : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A single item in a list or directory.

log :
List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of live region where new information is added in meaningful order and old information may disappear.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

The main content of a document.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of live region where non-essential information changes frequently.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

Content that represents a mathematical expression.

List (GlobalAttributes {})
-> List (Attribute a msg)
-> List (Attribute a msg)

An element whose implicit native role semantics will not be mapped to the accessibility API.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A section whose content is parenthetic or ancillary to the main content of the resource.

List
(GlobalAttributes
{ selected : Supported
, checked : Supported
, posinset : Supported
, setsize : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A selectable item in a select list.

List (GlobalAttributes {})
-> List (Attribute a msg)
-> List (Attribute a msg)

An element whose implicit native role semantics will not be mapped to the accessibility API.

List
(GlobalAttributes
{ expanded : Supported
, valuemax : Supported
, valuemin : Supported
, valuenow : Supported
, valuetext : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

An element that displays the progress status for tasks that take a long time.

List
(GlobalAttributes
{ checked : Supported
, posinset : Supported
, setsize : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A checkable input in a group of elements with the same role, only one of which can be checked at a time.

List
(GlobalAttributes
{ readonly : Supported
, required : Supported
, activedescendant : Supported
, expanded : Supported
, orientation : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A group of radio buttons.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A perceivable section containing content that is relevant to a specific, author-specified purpose and sufficiently important that users will likely want to be able to navigate to the section easily and to have it listed in a summary of the page. Such a page summary could be generated dynamically by a user agent or assistive technology.

row :
List
(GlobalAttributes
{ colindex : Supported
, level : Supported
, rowindex : Supported
, selected : Supported
, activedescendant : Supported
, expanded : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A row of cells in a tabular container.

List (GlobalAttributes {})
-> List (Attribute a msg)
-> List (Attribute a msg)

A structure containing one or more row elements in a tabular container.

List
(GlobalAttributes
{ sort : Supported
, colindex : Supported
, colspan : Supported
, expanded : Supported
, readonly : Supported
, required : Supported
, rowindex : Supported
, rowspan : Supported
, selected : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A cell containing header information for a row in a grid.

List
(GlobalAttributes
{ controls : Supported
, orientation : Supported
, valuemax : Supported
, valuemin : Supported
, valuenow : Supported
, valuetext : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area.

List
(GlobalAttributes
{ valuemax : Supported
, valuemin : Supported
, valuenow : Supported
, orientation : Supported
, valuetext : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A divider that separates and distinguishes sections of content or groups of menuitems.

List
(GlobalAttributes
{ valuemax : Supported
, valuemin : Supported
, valuenow : Supported
, orientation : Supported
, readonly : Supported
, valuetext : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A user input where the user selects a value from within a given range.

List
(GlobalAttributes
{ valuemax : Supported
, valuemin : Supported
, valuenow : Supported
, readonly : Supported
, required : Supported
, activedescendant : Supported
, valuetext : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A form of range that expects the user to select from among discrete choices.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of live region whose content is advisory information for the user but is not important enough to justify an alert, often but not necessarily presented as a status bar.

List
(GlobalAttributes
{ checked : Supported
, readonly : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of checkbox that represents on/off values, as opposed to checked/unchecked values.

tab :
List
(GlobalAttributes
{ posinset : Supported
, selected : Supported
, setsize : Supported
, expanded : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A grouping label providing a mechanism for selecting the tab content that is to be rendered to the user.

List
(GlobalAttributes
{ level : Supported
, multiselectable : Supported
, orientation : Supported
, activedescendant : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A list of tab elements, which are references to tabpanel elements.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A container for the resources associated with a tab, where each tab is contained in a tablist.

List
(GlobalAttributes
{ colcount : Supported
, rowcount : Supported
, expanded : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A section containing data arranged in rows and columns.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A word or phrase with a corresponding definition.

List
(GlobalAttributes
{ activedescendant : Supported
, autocomplete : Supported
, multiline : Supported
, placeholder : Supported
, readonly : Supported
, required : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of input that allows free-form text as its value.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of live region containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point.

List
(GlobalAttributes
{ orientation : Supported
, activedescendant : Supported
, expanded : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A collection of commonly used function buttons or controls represented in compact visual form.

List (GlobalAttributes { expanded : Supported })
-> List (Attribute a msg)
-> List (Attribute a msg)

A contextual popup that displays a description for an element.

List
(GlobalAttributes
{ multiselectable : Supported
, required : Supported
, activedescendant : Supported
, expanded : Supported
, orientation : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A type of list that may contain sub-level nested groups that can be collapsed and expanded.

List
(GlobalAttributes
{ activedescendant : Supported
, colcount : Supported
, expanded : Supported
, level : Supported
, multiselectable : Supported
, orientation : Supported
, readonly : Supported
, required : Supported
, rowcount : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

A grid whose rows can be expanded and collapsed in the same manner as for a tree.

List
(GlobalAttributes
{ checked : Supported
, expanded : Supported
, level : Supported
, posinset : Supported
, selected : Supported
, setsize : Supported
}
)
-> List (Attribute a msg)
-> List (Attribute a msg)

An option item of a tree. This is an element within a tree that may be expanded or collapsed if it contains a sub-level group of tree item elements.

Escape Hatch

String
-> List (Attribute a)
-> List (Attribute b msg)
-> List (Attribute b msg)

Use this to break out of this package's requirements. Useful if there is a role that this package does not support yet.