Role class
Options for WAI-ARIA role values.
See developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles
Constructors
- Role()
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- alert → const String
- A message with important, and usually time-sensitive, information. See related alertdialog and status.
- alertdialog → const String
- A type of dialog that contains an alert message, where initial focus goes to an element within the dialog. See related alert and dialog.
- application → const String
- A region declared as a web application, as opposed to a web document.
- article → const String
- A section of a page that consists of a composition that forms an independent part of a document, page, or site.
- A region that contains mostly site-oriented content, rather than page-specific content.
- An input that allows for user-triggered actions when clicked or pressed. See related link.
- cell → const String
- Identifies an element as being a cell in a tabular container that does not contain column or row header information. To be supported, the cell must be nested in an element with the role of row
- checkbox → const String
- A checkable input that has three possible values: true, false, or mixed.
- columnheader → const String
- A cell containing header information for a column.
- combobox → const String
- A presentation of a select; usually similar to a textbox where users can type ahead to select an option, or type to enter arbitrary text as a new item in the list. See related listbox.
- command → const String
- Defines a widget that performs an action but does not receive input data
- comment → const String
- Indicates a comment/reaction to some content on the page, or to a previous comment.
- complementary → const String
- 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.
- composite → const String
- An abstract role that indicates a widget that may contain navigable descendants or owned children.
- contentinfo → const String
- A large perceivable region that contains information about the parent document.
- definition → const String
- A definition of a term or concept.
- dialog → const String
- A dialog is an application window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response. See related alertdialog.
- directory → const String
- A list of references to members of a group, such as a static table of contents.
- document → const String
- A region containing related information that is declared as document content, as opposed to a web application.
- documentstructural → const String
- ARIA document-structure roles are used to provide a structural description for a section of content.
- feed → const String
- A feed is a dynamic scrollable list of articles in which articles are added to or removed from either end of the list as the user scrolls. A feed enables screen readers to use the browse mode reading cursor to both read and scroll through a stream of rich content that may continue scrolling infinitely by loading more content as the user reads
- figure → const String
- Identifies a figure inside page content where appropriate semantics do not already exist. A figure is generally considered to be one or more images, code snippets, or other content that puts across information in a different way to a regular flow of text
- form → const String
- A landmark region that contains a collection of items and objects that, as a whole, combine to create a form. See related search.
- generic → const String
- Creates a nameless container element which has no semantic meaning on its own
- grid → const String
- A grid is an interactive control which contains cells of tabular data arranged in rows and columns, like a table.
- gridcell → const String
- A cell in a grid or treegrid.
- group → const String
- 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 → const String
- A heading for a section of the page.
- img → const String
- A container for a collection of elements that form an image.
- input → const String
- A generic type of widget that allows user input.
- landmark → const String
- An abstract superclass for the aria role values for sections of content that are important enough that users will likely want to be able to navigate directly to them
- link → const String
- An interactive reference to an internal or external resource that, when activated, causes the user agent to navigate to that resource. See related button.
- list → const String
- A group of non-interactive list items. See related listbox.
- listbox → const String
- A widget that allows the user to select one or more items from a list of choices. See related combobox and list.
- listitem → const String
- A single item in a list or directory.
- log → const String
- A type of live region where new information is added in meaningful order and old information may disappear. See related marquee.
- main → const String
- The main content of a document.
- mark → const String
- Denotes content which is marked or highlighted for reference or notation purposes, due to the content's relevance in the enclosing context
- marquee → const String
- A type of live region where non-essential information changes frequently. See related log.
- math → const String
- Content that represents a mathematical expression.
- A type of widget that offers a list of choices to the user.
- A presentation of menu that usually remains visible and is usually presented horizontally.
- An option in a set of choices contained by a menu or menubar.
- A menuitem with a checkable state whose possible values are true, false, or mixed.
- A checkable menuitem in a set of elements with role menuitemradio, only one of which can be checked at a time.
- meter → const String
- A meter is a graphical display of a numeric value within a defined range. For example, showing battery percentage. A meter is not appropriate for values that do not have a meaningful maximum limit. Meters should not be used to indicate progress (for example loading), this should be communicated with the
- A collection of navigational elements (usually links) for navigating the document or related documents.
- none → const String
- The none role is a synonym for the presentation role; they both remove an element's implicit ARIA semantics from being exposed to the accessibility tree.
- note → const String
- A section whose content is parenthetic or ancillary to the main content of the resource.
- option → const String
- A selectable item in a select list.
- presentation → const String
- An element whose implicit native role semantics will not be mapped to the accessibility API.
- progressbar → const String
- An element that displays the progress status for tasks that take a long time.
- radio → const String
- A checkable input in a group of radio roles, only one of which can be checked at a time.
- radiogroup → const String
- A group of radio buttons.
- range → const String
- The range role is an abstract role. It must not be used by web authors. It is the superclass for structural roles for elements that accept a value within a range of values, including the meter role, progressbar and slider. For these three, consider using the
- region → const String
- A large perceivable section of a web page or document, that is important enough to be included in a page summary or table of contents, for example, an area of the page containing live sporting event statistics.
- roletype → const String
- The roletype role's properties describe the structural and functional purpose of objects that are assigned this role, or "instances". A role is a concept that can be used to understand and operate instances. Note
- row → const String
- A row of cells in a grid.
- rowgroup → const String
- A group containing one or more row elements in a grid.
- rowheader → const String
- A cell containing header information for a row in a grid.
- scrollbar → const String
- 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 → const String
- A landmark region that contains a collection of items and objects that, as a whole, combine to create a search facility. See related form.
- searchbox → const String
- The searchbox can be used instead of textbox when the text box is within an element with role search. A searchbox is the semantic equivalent is HTML's of type search, , which should be used instead if possible.
- section → const String
-
The structural section role is an abstract role for categorizing all the section subclass roles. The role
must not be used. Some subclasses, like alert, note, and tooltip, are useful, and can be used to add
semantics when no semantic HTML elements quite fits the purpose of a component. Others, like code, figure,
and subscript, aren't necessary, as there are HTML element equivalents. In this case,
- sectionhead → const String
- The structural sectionhead role is an abstract role for the subclass roles that identify the labels or summaries of the sections they label. The role must not be used. The four subclasses -- columnheader, heading, rowheader, and tab. There are HTML element equivalents, like, for columnheader, for rowheader, and any of the HTML headings,
- select → const String
- The structural select role, an abstract role, is superclass role for four form widgets, listbox, menu, radiogroup, and tree, which allow users to make selections from a set of choices.
- separator → const String
- A divider that separates and distinguishes sections of content or groups of menuitems.
- slider → const String
- A user input where the user selects a value from within a given range.
- A form of range that expects the user to select from among discrete choices.
- status → const String
- A container 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. See related alert.
- structure → const String
- Structure is a superclass abstract role for document structures, like as document, rowgroup, and sectionhead, that support the accessibility of dynamic web content by helping assistive technologies determine active content versus static document content. Some subclass roles, like section role, are in turn superclasses of other roles.
- suggestion → const String
- The suggestion landmark role semantically denotes a single proposed change to an editable document. This should be used on an element that wraps an element with an insertion role, and one with a deletion role.
- switch_aria → const String
- The ARIA switch role is identical to the checkbox role, except instead of being "checked" or "unchecked", it is either "on" or "off". Like the checkbox role, the aria-checked attribute is required. The two possible values are true and false. Unlike a
- tab → const String
- A grouping label providing a mechanism for selecting the tab content that is to be rendered to the user.
- table → const String
- Identifies the element containing the role as having a non-interactive table structure containing data arranged in rows and columns, similar to the native
- tablist → const String
- A list of tab elements, which are references to tabpanel elements.
- tabpanel → const String
- A container for the resources associated with a tab, where each tab is contained in a tablist.
- term → const String
- The term role can be used for a word or phrase with an optional corresponding definition. It is equivalent in semantics to the HTML element and the definition term (
- textbox → const String
- Input that allows free-form text as its value.
- timer → const String
- 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 → const String
- A collection of commonly used function buttons or controls represented in compact visual form.
- tooltip → const String
- A contextual popup that displays a description for an element.
- tree → const String
- A type of list that may contain sub-level nested groups that can be collapsed and expanded.
- treegrid → const String
- A grid whose rows can be expanded and collapsed in the same manner as for a tree.
- treeitem → const String
- 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 treeitem elements.
- widget → const String
- The abstract widget role is a superclass role for some interactive GUI elements and grouping roles. role="widget" should not be confused with widgets roles, such as option, menuitem, and searchbox.
- window → const String
- The window role, an abstract role, is a superclass for roles defining a browser or app window. The sub-class roles, currently only the dialog role, have a window-like GUI, whether it's a full native window or just a section of a document styled to look like a window, where role="dialog" would be appropriate.