Packages

object role extends Generic[String]

The attribute describes the role(s) the current element plays in the context of the document. This can be used, for example, by applications and assistive technologies to determine the purpose of an element. This could allow a user to make informed decisions on which actions may be taken on an element and activate the selected action in a device independent way. It could also be used as a mechanism for annotating portions of a document in a domain specific way (e.g., a legal term taxonomy). Although the role attribute may be used to add semantics to an element, authors should use elements with inherent semantics, such as p, rather than layering semantics on semantically neutral elements, such as div role="paragraph".

See also

https://www.w3.org/TR/wai-aria-1.1/#role_definitions

Linear Supertypes
Generic[String], Attr[String], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. role
  2. Generic
  3. Attr
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def :=[A](a: A)(implicit t: ValueType[A, String]): TagMod
    Definition Classes
    Generic → Attr
  4. final def :=?[O[_], A](oa: O[A])(implicit O: OptionLike[O], t: ValueType[A, String]): TagMod
    Definition Classes
    Attr
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def alert: TagMod

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

    A type of live region with important, and usually time-sensitive, information. See related alertdialog and status.

  7. def alertdialog: TagMod

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

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

  8. def application: TagMod

    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.

  9. def article: TagMod

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

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. final val attrName: String
    Definition Classes
    Attr
  12. def banner: TagMod

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

  13. def button: TagMod

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

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

  14. def cell: TagMod

    A cell in a tabular container.

    A cell in a tabular container. See related gridcell.

  15. def checkbox: TagMod

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

  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  17. def columnheader: TagMod

    A cell containing header information for a column.

  18. def combobox: TagMod

    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.

  19. def command: TagMod

    A form of widget that performs an action but does not receive input data.

  20. def complementary: TagMod

    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.

  21. def composite: TagMod

    A widget that may contain navigable descendants or owned children.

  22. def contentinfo: TagMod

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

  23. def definition: TagMod

    A definition of a term or concept.

    A definition of a term or concept. See related term.

  24. def dialog: TagMod

    A dialog is a descendant window of the primary window of a web application.

    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.

  25. def directory: TagMod

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

  26. def document: TagMod

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

  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(any: Any): Boolean
    Definition Classes
    Attr → AnyRef → Any
  29. def feed: TagMod

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

  30. def figure: TagMod

    A perceivable section of content that typically contains a graphical document, images, code snippets, or example text.

    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.

  31. def form: TagMod

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

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

  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def grid: TagMod

    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.

  34. def gridcell: TagMod

    A cell in a grid or treegrid.

  35. def group: TagMod

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

  36. def hashCode(): Int
    Definition Classes
    Attr → AnyRef → Any
  37. def heading: TagMod

    A heading for a section of the page.

  38. def img: TagMod

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

  39. def input: TagMod

    A generic type of widget that allows user input.

  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def landmark: TagMod

    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.

    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.

  42. def link: TagMod

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

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

  43. def list: TagMod

    A section containing listitem elements.

    A section containing listitem elements. See related listbox.

  44. def listbox: TagMod

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

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

  45. def listitem: TagMod

    A single item in a list or directory.

  46. def log: TagMod

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

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

  47. def main: TagMod

    The main content of a document.

  48. def marquee: TagMod

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

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

  49. def math: TagMod

    Content that represents a mathematical expression.

  50. def menu: TagMod

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

  51. def menubar: TagMod

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

  52. def menuitem: TagMod

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

  53. def menuitemcheckbox: TagMod

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

  54. def menuitemradio: TagMod

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

  55. def navigation: TagMod

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

  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def none: TagMod

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

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

  58. def note: TagMod

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

  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  61. def option: TagMod

    A selectable item in a select list.

  62. def presentation: TagMod

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

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

  63. def progressbar: TagMod

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

  64. def radio: TagMod

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

  65. def radiogroup: TagMod

    A group of radio buttons.

  66. def range: TagMod

    An input representing a range of values that can be set by the user.

  67. def region: TagMod

    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.

    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.

  68. def roletype: TagMod

    The base role from which all other roles in this taxonomy inherit.

  69. def row: TagMod

    A row of cells in a tabular container.

  70. def rowgroup: TagMod

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

  71. def rowheader: TagMod

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

  72. def scrollbar: TagMod

    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.

  73. def search: TagMod

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

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

  74. def searchbox: TagMod

    A type of textbox intended for specifying search criteria.

    A type of textbox intended for specifying search criteria. See related textbox and search.

  75. def section: TagMod

    A renderable structural containment unit in a document or application.

  76. def sectionhead: TagMod

    A structure that labels or summarizes the topic of its related section.

  77. def select: TagMod

    A form widget that allows the user to make selections from a set of choices.

  78. def separator: TagMod

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

  79. def slider: TagMod

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

  80. def spinbutton: TagMod

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

  81. def status: TagMod

    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.

  82. def structure: TagMod

    A document structural element.

  83. def switch: TagMod

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

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

  84. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  85. def tab: TagMod

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

  86. def table: TagMod

    A section containing data arranged in rows and columns.

    A section containing data arranged in rows and columns. See related grid.

  87. def tablist: TagMod

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

  88. def tabpanel: TagMod

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

  89. def term: TagMod

    A word or phrase with a corresponding definition.

    A word or phrase with a corresponding definition. See related definition.

  90. def textbox: TagMod

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

  91. def timer: TagMod

    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.

  92. final def toString(): String
    Definition Classes
    Attr → AnyRef → Any
  93. def toolbar: TagMod

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

  94. def tooltip: TagMod

    A contextual popup that displays a description for an element.

  95. def tree: TagMod

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

  96. def treegrid: TagMod

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

  97. def treeitem: TagMod

    An option item of a tree.

    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.

  98. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  99. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  100. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. def widget: TagMod

    An interactive component of a graphical user interface (GUI).

  102. def window: TagMod

    A browser or application window.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Generic[String]

Inherited from Attr[String]

Inherited from AnyRef

Inherited from Any

Ungrouped