Copyright © 2007 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability, trademark and document use rules apply.
Accessibility is often dependent on Assistive Technology (AT), tools that provide alternate modes of access for people with disabilities by transforming complex user interfaces into an alternate presentation. This transformation requires information about the role, state, and other semantics of specific portions of a document to be able to transform them appropriately. Rich Web applications typically rely on hybrid technologies such as DHTML and AJAX that combine multiple technologies: SVG, HTML, CSS, and JavaScript for example. The various technologies provide much but not all of the information needed to support AT adequately. This specification provides a Web-standard way to identify roles in dynamic Web content. The result is an interoperable way to associate behaviors and structure with existing markup.
This document and the States and Properties Module for Accessible Rich Internet Applications (WAI-ARIA States and Properties) [ARIA-STATE] fill information gaps identified by the Roadmap for Accessible Rich Internet Applications (WAI-ARIA Roadmap) [ARIA-ROADMAP]. The role attribute defined in the XHTML Role Attribute Module [XHTML-ROLES] is the preferred way to expose these roles in XHTML applications. This specification provides an ontology of roles that can be used to improve the accessibility and interoperability of Web Content and Applications.
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.
This document is a Working Draft by the Protocols & Formats Working Group of the Web Accessibility Initiative. This version provides better alignment with accessibility APIs, and documents applicable states and properties from States and Properties Module for Accessible Rich Internet Applications (WAI-ARIA States and Properties) [ARIA-STATE]. The document has also been restructured for easier comprehension, and explanatory materials expanded. Refer to the history of changes to WAI-ARIA Roles for more details.
Feedback on the model set out here is important to the success of the Web community in creating accessible Rich Internet Applications. The PFWG would like to know, in particular, if:
When addressing these questions, please consider them in the context of the companion documents mentioned above in the abstract. Comments on this document may be sent to public-pfwg-comments@w3.org (Archive).
To assist you in your review, refer to the history of changes to WAI-ARIA Roles.
Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
The disclosure obligations of the Participants of this group are described in the charter.
This section is informative.
The domain of Web accessibility defines how to make Web content usable by people with disabilities. People with some types of disabilities use Assistive Technology (AT) to interact with content. AT can transform the presentation of content into a format more suitable to the user, and can allow the user to interact in different ways than the author designed. In order to accomplish this, AT must understand the semantics of the content. Semantics are knowledge of roles, states, and properties, as a person would understand them, that apply to elements within the content. For instance, if a paragraph is semantically identified as such, AT can interact with it as a unit separable from the rest of the content, knowing the exact boundaries of that paragraph. A slider or tree control is a more complex example, in which various parts of a widget each have semantics that must be properly identified for the computer to support effective interaction.
Established content technologies define semantics for elements commonly used in those technologies. However, new technologies can overlook some of the semantics required for accessibility. Furthermore, new authoring practices evolve which override the intended semantics—elements that have one defined semantic meaning in the technology are used with a different semantic meaning intended to be understood by the user.
For example, Dynamic HTML can be used to present a tree control even though HTML lacks a semantic element for that. A different element must be used, possibly a list element with display instructions to make it look and behave like a tree control. Assistive technology, however, must re-present the element in a different modality and the display instructions may not be applicable. The AT will present it as a list, which has very different display and interaction from a tree control, and the user may be unsuccessful at understanding and operating the control.
The incorporation of Roles for Accessible Rich Internet Applications is a way for an author to provide proper type semantics on custom widgets (elements with repurposed semantics) to make these widgets accessible, usable and interoperable with assistive technologies. This specification identifies the types of widgets and structures that are recognized by accessibility products, by providing an ontology of roles for these that can be attached to content. This allows elements with a given role to be understood as a particular widget or structural type regardless of any semantic inherited from the implementing technology. Roles are a common property of platform Accessibility APIs which applications use to support assistive technologies. Assistive technology can then use the role information to provide effective presentation and interaction with these elements.
This role taxonomy currently includes interaction widget (user interface controls) and structural document (content organization) objects. The role taxonomy describes inheritance (widgets that are types of other widgets) and details what states and properties each role supports. When possible, information is provided about mapping of roles to accessibility APIs.
Roles are element types and should not change with time or user actions. Changing the role on an element from its initial value will confuse an assistive technology. Platform accessibility APIs, to which the roles are mapped by the browser, do not provide a vehicle to notify the assistive technology of a role type changing. If the old element type is be replaced by a new one, the corresponding element and its subtree should be removed from the document and a new one inserted containing the new role type.
Properties that change with time and events are described in States and Properties Module for Accessible Rich Internet Applications [ARIA-STATE]. ARIA States and Properties is a complementary specification to ARIA Roles. Elements with certain roles from this specification have certain states and properties from ARIA States and Properties.
In addition to the prose documentation, the role taxonomy is provided in Web Ontology Language (OWL) [OWL], which is an implementation of Resource Description Framework (RDF) [RDF]. Tools can use these to validate the implementation of roles in a given content document.
This section is informative.
This draft currently handles two aspects of roles—GUI functionality and structural relationships of the element. For more information see the Roadmap for Accessible Rich Internet Applications implementation examples [ARIA-ROADMAP, section 5.11] for the use of roles making dynamically generated content accessible.
This taxonomy is designed in-part to support the common roles found in platform accessibility API frameworks. Reference to roles found in this taxonomy by dynamic Web content may be used to support interoperability with assistive technologies.
The schema to support this standard has been designed to be extended so that custom roles can be created by extending base roles. This allows user agents to support at least the base role, and user agents that support the custom role can provide enhanced access. Note that much of this could be formalized in XML Schema [XSD]. However, being able to define similarities between roles, such as baseConcepts and more descriptive definitions would not be available in XSD.
At some point the working group intends to add roles for A, Adding concepts in the type of content for adaptation to the user scenario and B, Knowledge representation of Web content.
This section is informative.
While some terms are defined in place, the following definitions are used throughout this document. Familiarity with W3C XHTML 1.1 Recommendation [XHTML] and the W3C XML 1.0 Recommendation [XML] is highly recommended to understand these definitions.
This section is informative.
Complex user interfaces become inaccessible because adaptive technologies that provide alternative access, are often left guessing at the semantics behind portions of a document (see the Roadmap for Accessible Rich Internet Applications [ARIA-ROADMAP]). When you associate an element in your document to a role in this taxonomy you are associating all the information about that role that has been defined in this specification.
Roles in this specification are defined with RDF to build rich description of the expected behaviors of the role. For example:
checkbox supports being checked.tabpanel should be inside a tabcontainer, or a group would contain section.directory is a type of list.Hence referencing a role from the role taxonomy to an element in your document gives assistive technology the information it needs to handle an element correctly.
The Roles Taxonomy uses the XML Namespace [XMLNAMES] identifier
http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#
All examples are informative. Examples in this document that use the XML Namespace prefix "wairole" all assume a valid xmlns declaration in the document involved such as:
xmlns:wairole="http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#"
In this example a span has been used to create a tri-state checkbox (a
checkbox control that has three possible states). A role is used to make the
behavior of this simple widget known to the user agent. Properties that may
change with user actions (such as checked) use States
and Properties Module for Accessible Rich Internet Applications ([ARIA-STATE], Section 3.1.1.1).
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:wairole="http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#"
xmlns:aaa="http://www.w3.org/2005/07/aaa" >
<head>...</head>
<body>
...
<span class="checkboxtristate" id="chbox1" role="wairole:checkboxtristate" aaa:checked="mixed"
onkeydown="return checkBoxEvent(event);" onclick="return checkBoxEvent(event);" tabindex="0" >
A checkbox label
</span>
...
</body>
</html>
In this example the support schema will define a checkboxtristate as a type of option (which itself is defined as a type of input). Although it inherits all the supported states of an option, we also expect it to support checked set to "mixed".
Editorial Note: the PFWG has begun development of a best practices document, to externalize some of the instruction about how to use ARIA from the technical specification. When that document is more mature, we will return to this section and reconsider it in context of available resources and optimal understandability of this document.
An application becomes accessible when:
Roles make the different elements in the application semantically rich. User agents use the role semantics to understand how to handle each element. Roles can be used to build accessible applications by providing any missing information that the assistive technology needs to anticipate the behavior of the elements inside the application.
For example, to support accessibility the browser may create accessible objects of a Web page through the Accessibility API of the operating system. When the full semantics are provided and understood by the browser, the application will properly map the page to accessible objects of the operating system.
Use the semantic elements that are defined in the native markup language. For example, if you are using XHTML it is better to use the checkbox than to use a div element with role checkbox. Because properly used content is already repurposable, roles are best used when the mark up language does not support all the semantics that you need. When a role is used the semantics and behavior of the element are overridden by the role behavior.
Set roles to make sure elements behave predictably and correctly describe the behavior of each element within your application (unless elements behaviors are fully described by the native markup language). Roles for interactive elements should support all the states that the element could use. Once a role attribute is set it should not be changed as this will confuse an assistive technology. This does not preclude a document element being removed which has the role attribute set. Only states and properties may be changed for a given document element.
Look for groups within a page, and mark them using the most appropriate role that best describes their usage.
For example: a region of the page that contains a group of elements that are likely to change through an AJAX application could be tagged as a region.
Look for relationships between groups and mark them using the most appropriate property or attribute.
Sometimes the relationships can be made clear via the native mark up language, such as the label tag in HTML.
Sometimes this can be implied via the [DOM]. For example, when a well marked up list contains list items it is known that they belong to the containing list. In such cases you do not need to set additional properties to make that explicit.
In other cases use the States and Properties Module for Accessible Rich Internet Applications to state relationships. For example: If container A contains search results, and container B contains the search controls, then mark each container as a region and set the controls property in region B to reference region A.
Extra states and properties have been provided by the States and Properties Module for
Accessible Rich Internet Applications [ARIA-STATE]. For example, if the user is required
to fill in a form element set the required property to true.
An important addition in the States and Properties Module for Accessible
Rich Internet Applications is new extensions of tabindex. Now, with the tabindex change, the author is allowed to give any element keyboard focus
(and not just form elements or anchors). In this paradigm shift, the user
experience should be to use tabbing or keyboard mnemonics to move focus to
widgets on the Web page and then use the arrow keys to navigate the object.
The tabindex change enables support of User Agent
Accessibility Guidelines ([UAAG]).
Associate style sheet selectors with accessibility states and properties so that as states change, the view of the page changes in unison. This reduces unneeded scripting and helps with accessibility. For example, the author should have an associated selector that responds to a form element being required or a gridcell being selected.
Conforming user agents will notify assistive technologies of changes in states. Synchronizing the information given to assistive technologies with changes in style rendering allows for consistency, and avoids accessibility bugs. This is a powerful use of ARIA states and properties for browsers supporting the appropriate level of style sheets.
Some platform accessibility APIs provide events for applications to notify the assistive technology when pop-ups such as menus, alerts, and dialogs come into view or go away. Rich Internet Applications can assist browsers which support these conventions by:
Creating an entire section and then insert it into the [DOM], as a subtree of the parent element activated to show the pop-up, to show a pop-up and then removing the section from the inserted area when the pop-up goes away.
ORUsing the following style sheet properties to show and hide document sections being used to represent the pop-up items, menus or dialogs:
display:blockdisplay:nonevisibility:visiblevisibility:hiddenBy monitoring these behaviors a user agent may use this information to notify assistive technology that the pop-up has occurred by generating the appropriate accessibility API event.
Some assistive technologies may use the DOM directly to determine these when pop-up occurs. In this case, the first mechanism of writing a section to the DOM would work using the DOM events.
A basic tree view allows the user to select different list items and expand and collapse embedded lists. Arrow keys are used to navigate through a tree, including left/right to collapse/expand sub trees. Double clicking with the mouse also toggles expansion.
There is no tree element in XHTML 1.0 that supports our behavior including expansion, so we will need to use roles. Therefore, our first step is setting roles.
Our tree will need roles that support embedded list behavior and expandable/collapsible embedded lists. The roles that support tree behavior for a tree are:
Tree: The main container element for our tree. A form of a select (or, generally, of a list having groups inside groups) where subtrees can
be collapsed and expanded.Treeitem: An option item of a tree. This is an element within a
tree which may be expanded or collapsedTree relationships can be made simply via the DOM and logical structure of your page.
A tree element will be the main container containing all other elements in
the tree.
Each selectable item in the tree will be a treeitem.
When a treeitem contains an embedded list of treeitems they will be all embedded in a group. A group should be contained inside the tree item that is the parent item.
Tree relationships are like list relationships in XHTML. Group and tree elements act like list containers (OL and UL). A tree item acts like a list item (li) in XHTML.
Because treeitems and groups commonly both use div elements it is recommended to add a comment next to closing treeitems that contain embedded tree groups.
<div x2:role="wairole:tree" >
<div role="wairole:treeitem" >Veggies
<div role="wairole:group">
<div role="wairole:treeitem">Green
<div role="wairole:group">
<div role="wairole:treeitem">Asparagus</div>
<div role="wairole:treeitem">Kale</div>
<div role="wairole:treeitem" >Leafy
<div role="wairole:group">
<div role="wairole:treeitem">Lettuce</div>
<div role="wairole:treeitem">Kale</div>
<div role="wairole:treeitem">Spinach</div>
<div role="wairole:treeitem">Chard</div>
</div>
</div> ---close leafy
<div role="wairole:treeitem">Green beans</div>
</div>
</div> ---close green
<div role="wairole:treeitem">Legumes</div>
<div role="wairole:treeitem" >Yellow
<div role="wairole:group">
<div role="wairole:treeitem">Bell peppers</div>
<div role="wairole:treeitem">Squash</div>
</div>
</div> ---close yellow
</div>
</div> ---close veggies
</div> ---close tree
Sometimes a tree structure is not explicit via the DOM and logical structure of a page. In such cases the relationships must still be made explicit using the States and Properties Module.
Example:
<div x2:role="wairole:treeitem" aaa:haschild="yellowtreegroup">Yellow<div> … <div id="yellowtreegroup" role="wairole:group"> <div role="wairole:treeitem">Bell peppers</div> <div role="wairole:treeitem">Squash</div> … </div>
Although this is allowed it may affect performance.
Control the behavior of the element using XML Events [XML-EVENTS] and States.
For example, use the aaa Namespace [XML-NAMES] with supporting scripts to control which tree elements are expanded
<div tabindex="-1" role="wairole:treeitem" aaa:expanded="true">Yellow</div>
And use events to device independent events with supporting JavaScript to handle user interaction.
<div role="wairole:tree" tabindex="-1" onfocus="return treeItemFocus(event);" onclick="return treeItemEvent(event);" ondblclick="return treeItemEvent(event);" onkeydown="return treeItemEvent(event);" onkeypress="return treeItemEvent(event);">
Then create JavaScript support to control the event driven behavior of the application.
This section is normative.
Roles are provided in XML-based languages using an attribute designated for the purpose. Roles from this ontology are indicated as values of that role attribute. In order to indicate that the roles are used as specified in this document, the document must use the following namespace in the attribute value: http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#.
Generally this namespace is declared on the root element of the document as specified in XML Namespaces [XML-NAMES]. Examples in this document use the namespace prefix “wairole” to indicate this namespace.
Editorial Note: There is discussion about changing the suggested prefix to “ariarole”. There is not yet group consensus about this.
For example, the start tag of a root element that includes the appropriate namespace declaration might look like:
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" xmlns:wairole="http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#" >
XHTML 1.1 and higher provides the XHTML Role Attribute Module [XHTML-ROLES] to attach roles to documents. Include this module as defined in the Role Attribute specification, and then use the “role” attribute as needed. Use the namespace prefix defined in the root element, and values for the attribute from the ontology above. For example:
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml "xmlns:wairole="http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#"><body> <table id="table1" role="wairole:grid"> ... </table> </body></html>
XHTML 1.0 does not support DTD modularization. It is therefore necessary to provide the role attribute using its own namespace. For example:
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:xhtml10="http://www.w3.org/1999/xhtml" xmlns:wairole="http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#"><body> <table id="table1" xhtml10:role="wairole:grid"> ... </table> </body></html>
Other XML languages may provide their own role attribute facility, in which case you should use that language feature. If the language does not provide a role attribute, DTD modularization can be used to include the XHTML Role Attribute Module [XHTML-ROLES]. For example:
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:wairole="http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#" >
There is no normative way to apply roles in HTML, but it is recommended to use the HTML implementation technique.
This section is normative.
This specification defines a Taxonomy called Roles. The Roles Taxonomy uses the XML Namespace [XMLNAMES] identifier
http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#
All examples are informative. Examples in this document that use the XML Namespace prefix "wairole" all assume a valid xmlns declaration such as
xmlns:wairole="http://www.w3.org/2005/01/wai-rdf/GUIRoleTaxonomy#"
in the document involved.
The remainder of this section describes the class's instances and properties in this taxonomy, the semantics, and provides an RDF [RDF] Schema.
Roles are defined and described by their properties. Properties define the structural function of a role, such as: What a role is, concepts behind it, what it can contain, what it must contain.
In the case of widgets this also includes how it interacts with the user agent based on mapping to HTML forms and XForms, allowed states and required states.
The are three properties that describe the relationship between concepts. They are:
Type and subclasses - (from RDF Schema [RDFS]) this implies inheritance, which means, among other things, the inheritance of limitations and properties. Other than well known stable specifications, inheritance may be restricted to items defined inside this specification so that items can not be changed and affect inherited classes.
For example: Buttonundo is a subclass or type of a button. If we change the properties and expected behavior of a button then the properties and behavior of buttonundo will also change.
relatedConcept - A relatedConcept is a similar or related idea from other specifications. Concepts that are related are not necessarily identical. relatedConcepts do not inherit properties from each other. Hence if the definition of a type changes, the properties, behavior and definition of a relatedConcept is not affected.
For example: A grid is like a table. Therefore, a grid has a relatedConcept of a table as defined at http://www.w3.org/TR/html4/struct/tables.html#edef-TABLE. However if the definition of table is modified our definition of a grid will not be affected.
baseConcept - A baseConcept is like a "borrowed" concept. BaseConcept is similar to type, but without inheritance of limitations and properties. baseConcepts are designed as a substitute for inheritance for external concepts. A baseConcept is like a relatedConcept except that baseConcepts are almost identical to each other.
For example: the checkbox defined in this document has the same functionality and anticipated behavior as a checkbox defined in http://www.w3.org/MarkUp/HTML#checkbox.
Therefore, a checkbox has a baseConcept of a checkbox as defined at http://www.w3.org/MarkUp/HTML#checkbox. However, if http://www.w3.org/MarkUp/HTML#checkbox is modified, the definition of a checkbox in this document will not be not affected.
The Roles Taxonomy supports the following additional properties:
Property |
Description |
Values |
|---|---|---|
a supportedState must be supported by this role. Typically refers to states from the aaa namespace |
Any valid [RDF] object reference, such as a URI. |
|
A child element that must be contained by this role. For example a list must contain a listitem. |
Any valid [RDF] object reference, such as a URI or [RDF] ID. |
|
Context, where this role is allowed. For example a list item is allowed inside a list. |
Any valid [RDF] object reference, such as a URI or [RDF] ID. | |
The media type, where the Role is allowed - a type of scope |
Any valid [RDF] object reference, such as a URI or [RDF] ID. | |
Computational mechanism for determine the accessible name of the object to which the role applies. This may be computed from the children of the object or the title attribute. |
Any valid [RDF] object reference, such as a URI or [RDF] Node ID. Recommended values: Child, title, content. |
Some states and properties are applicable to all roles, and most are applicable to all elements regardless of role. In addition to explicitly expressed supported states and properties, the following global states and properties are supported by roles as well. These include:
To support the current user scenario this specification defines roles that A, help define Widgets (For example, a tristate Checkbox) and B, help define page structure (for example, a section header).
Graph of the data model—Picture of the relationships described in the role data model (large)
Editorial Note: Is this image useful? Perhaps a manually generated one would be more helpful, one that's more UML-like.
Specific roles are enumerated below in Supported Roles.
This section contains an alphabetical list of ARIA roles to be used by rich internet application authors. For a detailed definition of the taxonomy supporting these ARIA roles refer to section 3.4.2.
| Role | Definition |
|---|---|
| alert | A message with an alert or error information. |
| alertdialog | A separate window with an alert or error information. |
| application | A software unit executing a set of tasks for its users |
| breadcrumbs | Bread crumb navigation list. |
| button | Allows for user-triggered actions. |
| checkbox | A control that has two possible value states (an equivalent to a boolean). |
| checkboxtristate | A control that has three possible values, (1 0 -1). Often found in installer where an option has been partially installed. |
| columnheader | A table cell containing header information for a column. |
| combobox | Combobox is a presentation of a select, where you can type to locate a selected item. |
| description | Descriptive content for a page element which references this element via describedby. |
| dialog | A dialog is a small application window that sits above the application and is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response. |
| directory | A list of references to members of a single group. |
| document | Content that contains related information, such as a book. The document role is used to tell the screen reader to use a document browsing mode, because screen readers use most of the keyboard navigation keys to provide its own keyboard user interface for this type of navigation. |
| grid | A grid is a table type that may be editable. |
| gridcell | A gridcell is a table cell in a grid. Gridcells may be active, editable, and selectable. Cells may have relationships such as controls to address the application of functional relationships. |
| group | A group is a section of user interface objects which would not be included in a page summary or table of contents by an assistive technology. |
| imggroup | An imggroup is a container for a collection elements that form an image. |
| link | Interactive reference to a resource (note, that in [XHTML] 2.0 any element can have an href attribute and thus be a link) |
| list | Group of small items. |
| listbox | Todo: Created per Rich and Aaron's analysis/cleanup |
| listitem | A single item in a list. |
| log | A region where new information is added and old information may disappear such as chat logs, messaging, game log or an error log. |
| marquee | Todo: |
| menu | Offers a list of choices to the user. A menu is often a list of links to important sections of a Document or a Site. |
| menubar | A menubar is a container of menu items. Each menu item may activate a new sub-menu. Navigation behavior should be similar to the typical menu bar graphical user interface. |
| menuitem | A link in a menu. This is an option in a group of choices contained in a menu. |
| menuitemcheckbox | Defines a menuitem which is checkable (tri-state). |
| menuitemradio | Indicates that you have a menu item which is part of a group of menuitemradio roles. |
| option | A selectable item in a list represented by a select. |
| presentation | An element whose role is presentational does not need to be mapped to the accessibility API. |
| progressbar | Used by applications for tasks that take a long time to execute, to show the execution progress. |
| radio | A radio is an option in single-select list. Only one radio control in a radiogroup can be selected at the same time. |
| radiogroup | A group of radio controls. |
| region | Region is a large perceivable section on your web page. |
| rowheader | A table cell containing header information for a row. |
| secret | Provides the user with the ability to supply information to the system in a manner that makes it difficult for someone else (who may be watching) to discern the value that is being supplied. |
| separator | A line or bar that separates and distinguishes sections of content. This is a visual separator between sections of content. Separators are found between lists of menu items in a menu. |
| slider | A user input where the user selects an input in a given range. This form of range expects an analog keyboard interface. |
| spinbutton | A form of Range that expects a user selecting from discrete choices. |
| status | This is a container for process advisory information to give feedback to the user. It must have a subtree. This object typically does not receive focus. |
| tab | A tab is a tabpanel header. Tab is used as a grouping label, providing a link for selecting the tabcontent to be rendered to the user. |
| table | A table contains cells of tabular data arranged in rows and columns. |
| tablist | A list of references to tabpanels of a tabcontainer. |
| tabpanel | Tabpanel is a container for the resources associated with a tab. |
| td | A table cell containing data. |
| textarea | This is a multi-line editable text box. For use when no standard form element exists with this functionality. |
| textfield | Free-form data entry for short on-line content. |
| th | A table cell containing header information. |
| toolbar | A toolbar is a collection of commonly used functions represented in compact visual form. |
| tooltip | A popup that displays a description for an element when a user passes over or rests on that element. Supplement to the normal tooltip processing of the user agent. |
| tree | A form of a list having groups inside groups, where sub trees can be collapsed and expanded. |
| treeitem | An option item of a tree. This is an element within a tree that may be expanded or collapsed |
*Note: More base types will be added as the working group adds user cases
The following roles are used as base types for applied roles. They are not to be used by Web Authors and would not be exposed as role definitions for incorporation into a Web page. Base classes are referenced within the taxonomy and are used to build a picture of the role taxonomy class hierarchy within the taxonomy.
| Parent Role: | |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
Describes the structural and functional purpose of an element. A Role is also a concept.
| Parent Role: | roletype |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | disabled |
| Inherited States and Properties: | |
| Name Reference: |
A component of a GUI (graphical user interface)
| Parent Role: | widget |
|---|---|
| Related Concepts: | [XFORMS] input |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
Generic type for widgets that can have a value
| Parent Role: | input |
|---|---|
| Related Concepts: | [XFORMS] input |
| Supported States and Properties: | readonly (default set to false) |
| Inherited States and Properties: | |
| Name Reference: | Title |
Generic type for the inputs that allow free-form text as their value
| Parent Role: | |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
A form control that allows the user to make selections from a set of choices. A select must contain an option.
| Parent Role: | input |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
Represents a range of values that can be set by the user.
| Parent Role: | roletype |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Child content or title attribute |
A base abstract class representing a renderable structural containment unit found in a document or application.
| Parent Role: | roletype |
|---|---|
| Related Concepts: | [HTML]/[DTB]/NIMAS h2, h3... |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
The section head labels or summarizes the topic of its related section
| Parent Role: | roletype |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
Browser or application window
Widget Roles all map to accessibility APIs.
| Parent Role: | widget |
|---|---|
| Related Concepts: | [HTML] Link |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
Interactive reference to a resource (note, that in [XHTML] 2.0 any element can have an href attribute and thus be a link)
| Parent Role: | select |
|---|---|
| Related Concepts: | [HTML] select |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
Combobox is a presentation of a select, where you can type to locate a selected item.
NOTE: In [XFORMS] the same select can have one of 3 appearances: combo-box, drop-down box or group of radio-buttons. Besides, many browsers (if not all of them) allow users to type in a drop-down select as well.
| Parent Role: | select |
|---|---|
| Related Concepts: | [HTML] select |
| Supported States and Properties: | multiselectable |
| Inherited States and Properties: | |
| Name Reference: | Title |
| Parent Role: | |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | selected |
| Inherited States and Properties: | |
| Name Reference: |
|
| Parent Role: | checkboxtristate |
|---|---|
| Related Concepts: | [HTML] input (type : checkbox) |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
A control that has two possible value states (an equivalent to a boolean).
| Parent Role: | option |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | readonly |
| Inherited States and Properties: | |
| Name Reference: |
|
A control that has three possible values, (1 0 -1). Often found in installer where an option has been partially installed.
| Parent Role: | checkbox |
|---|---|
| Related Concepts: | [HTML] input (type : radio) |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
A radio is an option in single-select list. Only one radio control in a radiogroup can be selected at the same time.
| Parent Role: | select |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
A group of radio controls.
| Parent Role: | |
|---|---|
| Related Concepts: | [XFORMS] trigger |
| Supported States and Properties: | pressed |
| Inherited States and Properties: | |
| Name Reference: |
|
Allows for user-triggered actions.
Buttons are mostly used for discrete, atomic actions. Its value is cognitive; the idea that this is a user action opportunity is made very clear by making it look like a front-panel button on a device. The animation of the button in response to indirect (by mouse) manipulation fosters the illusion of direct manipulation and keeps user cognition in sync with the user interface perception of user action events. Standardizing the appearance of buttons enhances recognition as buttons and arraying them compactly in toolbars, for example.
Buttons support the optional state pressed . Buttons with this state present are toggle buttons. When pressed is "true" the button is depressed, when pressed is "false" it is not depressed.
| Parent Role: | |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
Indicates that you have a menu item which is part of a group of menuitemradio roles.
Checking of one menuitemradio in a group will unchecked the other group members.
Menuitems should also be separated into a group by a separator.
| Parent Role: | |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
Defines a menuitem which is checkable (tri-state).
The checked state indicates whether the menu item is checked, unchecked, or mixed.
| Parent Role: | widget |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
Used by applications for tasks that take a long time to execute, to show the execution progress.
This lets the user know that the user's action request has been accepted and that the application continues (or ceases, in the case of a static display) to make progress toward completing the requested action.
| Parent Role: | input |
|---|---|
| Related Concepts: | [HTML] input (type : password) |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
Provides the user with the ability to supply information to the system in a manner that makes it difficult for someone else (who may be watching) to discern the value that is being supplied.
Disadvantage: Passwords have to be typed blind without the usual echo to the screen. Web users get used to having their input echoed, type badly, and in particular not having people able to confirm what is entered runs risk such as having account locked if three non-accepted tries happen in some time window.
Disadvantage: Policy not to display is usually taken to be absolute; whereas a user with screen blank and earphone in use can get the typing echoed privately not subject to having a lurker purloin the password.
| Parent Role: | widget |
|---|---|
| Related Concepts: | [HTML] hr |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
A line or bar that separates and distinguishes sections of content. This is a visual separator between sections of content. Separators are found between lists of menu items in a menu.
| Parent Role: | range |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
A user input where the user selects an input in a given range. This form of range expects an analog keyboard interface.
A slider has the added functionality of being able to select a value through the use of a visible slider. The slider would be keyboard accessible and provide a visible thumb position that represents the current position within the slider.
| Parent Role: | range |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | readonly |
| Inherited States and Properties: | |
| Name Reference: | Title |
A form of Range that expects a user selecting from discrete choices.
A spinbutton allows the user to select from the given range through the use of an up and down button. Visibly, the current value is incremented or decremented until a maximum or minimum value is reached. This functionality should be accomplished programmatically through the use of up and down arrows on the keyboard.
| Parent Role: | textbox |
|---|---|
| Related Concepts: | [HTML] textarea |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
This is a multi-line editable text box. For use when no standard form element exists with this functionality.
Intended use is in languages that do not have a textarea object (such as SVG). The user would use this role when additional states or properties are applied to a standard textarea control. This is to indicate to the user agent that it must process additional states and properties such as invalid and required.
| Parent Role: | textbox |
|---|---|
| Related Concepts: | [HTML] input (type : text) |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
Free-form data entry for short on-line content.
Intended use is in languages that do not have a textfield object (such as SVG). The user would use this role when additional states or properties are applied to a standard textarea control.
Textfield is used to indicate to the user agent that it must process additional states and properties such as invalid and required.
Editorial Note: this is not only for SVG. The inputtokenizer from SAP is an example. This uses an editable div with designmode="on". One can create an editable textfield in the DOM in today's browsers without using an html form text field:
<div designmode="on" role="wairole:textfield" aaa:readonly="false"> type away </div>
| Parent Role: | select |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | multiselectable |
| Inherited States and Properties: | |
| Name Reference: |
|
A form of a list having groups inside groups, where sub trees can be collapsed and expanded.
| Parent Role: | option |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: |
|
An option item of a tree. This is an element within a tree that may be expanded or collapsed
| Parent Role: | widget |
|---|---|
| Related Concepts: | |
| Supported States and Properties: | activedescendent |
| Inherited States and Properties: | |
| Name Reference: |
This is a container for process advisory information to give feedback to the user. It must have a subtree. This object typically does not receive focus.
Some cells of a Braille display may be reserved to render the status.
| Parent Role: | status |
|---|---|
| Related Concepts: | [XFORMS] alert |
| Supported States and Properties: | |
| Inherited States and Properties: | |
| Name Reference: | Title |
A message with an alert or error information.
Alerts are used to convey messages to alert the user. In the case of audio warnings this is an accessible alternative for a hearing impaired user. The alert role goes on the container of the document subtree containing the alert message. Alerts are specialized forms of the status role which should be processed as an atomic live region. Alerts do not require user input and therefore should not receive focus. Alerts should not receive focus or require user input and therefore users should not be required to close an alert. The user agent may consider firing an accessibility alert event, when the alert is created, provided one is specified by the intended accessibility API.