austinshenk / elm-w3 / 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 =
Help.Attribute a

Base Type for Aria Attributes


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

Attributes that can be assigned to any Role

Roles

alert : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

alertdialog : List (GlobalAttributes { expanded : Help.Supported, modal : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

application : List (GlobalAttributes { activedescendant : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

article : List (GlobalAttributes { expanded : Help.Supported, posinset : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

banner : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A region that contains mostly site-oriented content, rather than page-specific content.

button : List (GlobalAttributes { expanded : Help.Supported, pressed : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

cell : List (GlobalAttributes { expanded : Help.Supported, colindex : Help.Supported, colspan : Help.Supported, rowindex : Help.Supported, rowspan : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A cell in a tabular container.

checkbox : List (GlobalAttributes { checked : Help.Supported, readonly : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

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

A cell containing header information for a column.

combobox : List (GlobalAttributes { controls : Help.Supported, expanded : Help.Supported, autocomplete : Help.Supported, readonly : Help.Supported, required : Help.Supported, activedescendant : Help.Supported, orientation : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

complementary : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

contentinfo : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

definition : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A definition of a term or concept.

dialog : List (GlobalAttributes { expanded : Help.Supported, modal : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

directory : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

document : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

feed : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

figure : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

form : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

grid : List (GlobalAttributes { level : Help.Supported, multiselectable : Help.Supported, readonly : Help.Supported, activedescendant : Help.Supported, colcount : Help.Supported, expanded : Help.Supported, rowcount : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

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

A cell in a grid or treegrid.

group : List (GlobalAttributes { activedescendant : Help.Supported, expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

heading : List (GlobalAttributes { level : Help.Supported, expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A heading for a section of the page.

img : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

link : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

An interactive reference to an internal or external resource that, when activated, causes the user agent to navigate to that resource.

list : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A section containing listitem elements.

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

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

listitem : List (GlobalAttributes { level : Help.Supported, posinset : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A single item in a list or directory.

log : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

main_ : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

The main content of a document.

marquee : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

math : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

Content that represents a mathematical expression.

menu : List (GlobalAttributes { activedescendant : Help.Supported, expanded : Help.Supported, orientation : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A type of widget that offers a list of choices to the user.

menubar : List (GlobalAttributes { activedescendant : Help.Supported, expanded : Help.Supported, orientation : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A presentation of menu that usually remains visible and is usually presented horizontally.

menuitem : List (GlobalAttributes { posinset : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

An option in a set of choices contained by a menu or menubar.

menuitemcheckbox : List (GlobalAttributes { checked : Help.Supported, posinset : Help.Supported, readonly : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A menuitem with a checkable state whose possible values are true, false, or mixed.

menuitemradio : List (GlobalAttributes { checked : Help.Supported, posinset : Help.Supported, readonly : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

navigation : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A collection of navigational elements (usually links) for navigating the document or related documents.

none : List (GlobalAttributes {}) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

note : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

option : List (GlobalAttributes { selected : Help.Supported, checked : Help.Supported, posinset : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A selectable item in a select list.

presentation : List (GlobalAttributes {}) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

progressbar : List (GlobalAttributes { expanded : Help.Supported, valuemax : Help.Supported, valuemin : Help.Supported, valuenow : Help.Supported, valuetext : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

radio : List (GlobalAttributes { checked : Help.Supported, posinset : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

radiogroup : List (GlobalAttributes { readonly : Help.Supported, required : Help.Supported, activedescendant : Help.Supported, expanded : Help.Supported, orientation : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A group of radio buttons.

region : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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 : Help.Supported, level : Help.Supported, rowindex : Help.Supported, selected : Help.Supported, activedescendant : Help.Supported, expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A row of cells in a tabular container.

rowgroup : List (GlobalAttributes {}) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

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

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

scrollbar : List (GlobalAttributes { controls : Help.Supported, orientation : Help.Supported, valuemax : Help.Supported, valuemin : Help.Supported, valuenow : Help.Supported, valuetext : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

search : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

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

A type of textbox intended for specifying search criteria.

separator : List (GlobalAttributes { valuemax : Help.Supported, valuemin : Help.Supported, valuenow : Help.Supported, orientation : Help.Supported, valuetext : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

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

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

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

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

status : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

switch : List (GlobalAttributes { checked : Help.Supported, readonly : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

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

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

tablist : List (GlobalAttributes { level : Help.Supported, multiselectable : Help.Supported, orientation : Help.Supported, activedescendant : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

tabpanel : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

table : List (GlobalAttributes { colcount : Help.Supported, rowcount : Help.Supported, expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A section containing data arranged in rows and columns.

term : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A word or phrase with a corresponding definition.

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

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

timer : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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.

toolbar : List (GlobalAttributes { orientation : Help.Supported, activedescendant : Help.Supported, expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

tooltip : List (GlobalAttributes { expanded : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

A contextual popup that displays a description for an element.

tree : List (GlobalAttributes { multiselectable : Help.Supported, required : Help.Supported, activedescendant : Help.Supported, expanded : Help.Supported, orientation : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.Attribute a msg)

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

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

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

treeitem : List (GlobalAttributes { checked : Help.Supported, expanded : Help.Supported, level : Help.Supported, posinset : Help.Supported, selected : Help.Supported, setsize : Help.Supported }) -> List (W3.Html.Help.Attribute a msg) -> List (W3.Html.Help.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

role : String -> List (Help.Attribute a) -> List (W3.Html.Help.Attribute b msg) -> List (W3.Html.Help.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.