SemanticsRole enum
An enum to describe the role for a semantics node.
The roles are translated into native accessibility roles in each platform.
Values
- none â const SemanticsRole
-
Does not represent any role.
- tab â const SemanticsRole
-
A tab button.
See also:
- tabBar, which is the role for containers of tab buttons.
- tabBar â const SemanticsRole
-
Contains tab buttons.
See also:
- tab, which is the role for tab buttons.
- tabPanel â const SemanticsRole
-
The main display for a tab.
- dialog â const SemanticsRole
-
A pop up dialog.
- alertDialog â const SemanticsRole
-
An alert dialog.
- table â const SemanticsRole
-
A table structure containing data arranged in rows and columns.
See also:
- cell, row, columnHeader for table related roles.
- cell â const SemanticsRole
-
A cell in a table that does not contain column or row header information.
See also:
- table,row, columnHeader for table related roles.
- row â const SemanticsRole
-
A row of cells or or columnHeaders in a table.
See also:
- table ,cell,columnHeader for table related roles.
- columnHeader â const SemanticsRole
-
A cell in a table contains header information for a column.
See also:
- dragHandle â const SemanticsRole
-
A control used for dragging across content.
For example, the drag handle of ReorderableList.
- spinButton â const SemanticsRole
-
A control to cycle through content on tap.
For example, the next and previous month button of a CalendarDatePicker.
- comboBox â const SemanticsRole
-
A input field with a dropdown list box attached.
For example, a DropdownMenu
-
A presentation of menu that usually remains visible and is usually presented horizontally.
For example, a MenuBar.
-
A permanently visible list of controls or a widget that can be made to open and close.
For example, a MenuAnchor or DropdownButton.
-
An item in a dropdown created by menu or menuBar.
See also:
- menuItemCheckbox, a menu item with a checkbox. The menuItemCheckbox can also be used within menu and menuBar.
- menuItemRadio, a menu item with a radio button. This role is used by menu or menuBar as well.
-
An item with a checkbox in a dropdown created by menu or menuBar.
See also:
- menuItem and menuItemRadio for menu related roles.
-
An item with a radio button in a dropdown created by menu or menuBar.
See also:
- menuItem and menuItemCheckbox for menu related roles.
- list â const SemanticsRole
-
A container to display multiple listItems in vertical or horizontal layout.
For example, a
LisView
or Column. - listItem â const SemanticsRole
-
An item in a list.
- form â const SemanticsRole
-
An area that represents a form.
- tooltip â const SemanticsRole
-
A pop up displayed when hovering over a component to provide contextual explanation.
- loadingSpinner â const SemanticsRole
-
A graphic object that spins to indicate the application is busy.
For example, a CircularProgressIndicator.
- progressBar â const SemanticsRole
-
A graphic object that shows progress with a numeric number.
For example, a LinearProgressIndicator.
- hotKey â const SemanticsRole
-
A keyboard shortcut field that allows the user to enter a combination or sequence of keystrokes.
For example, Shortcuts.
- radioGroup â const SemanticsRole
-
A group of radio buttons.
- status â const SemanticsRole
-
A component to provide advisory information that is not important to justify an alert.
For example, a loading message for a web page.
- alert â const SemanticsRole
-
A component to provide important and usually time-sensitive information.
The alert role should only be used for information that requires the user's immediate attention, for example:
- An invalid value was entered into a form field.
- The user's login session is about to expire.
- The connection to the server was lost so local changes will not be saved.
- complementary â const SemanticsRole
-
A supporting section that relates to the main content.
The compelementary role is one of landmark roles. This role can be used to describe sidebars, or call-out boxes.
For more information, see: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/complementary_role
- contentInfo â const SemanticsRole
-
A section for a footer, containing identifying information such as copyright information, navigation links and privacy statements.
The contentInfo role is one of landmark roles. For more information, see: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/contentinfo_role
- main â const SemanticsRole
-
The primary content of a document.
The section consists of content that is directly related to or expands on the central topic of a document, or the main function of an application.
This role is one of landmark roles. For more information, see: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/main_role
-
A region of a web page that contains navigation links.
This role is one of landmark roles. For more information, see: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/navigation_role
- region â const SemanticsRole
-
A section of content sufficiently important but cannot be descrived by one of the other landmark roles, such as main, contentinfo, complementary, or navigation.
For more information, see: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/region_role
Properties
- hashCode â int
-
The hash code for this object.
no setterinherited
- index â int
-
A numeric identifier for the enumerated value.
no setterinherited
- name â String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - 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
-
values
â const List<
SemanticsRole> - A constant List of the values in this enum, in order of their declaration.