AriaAttrs

com.raquo.laminar.defs.attrs.AriaAttrs
trait AriaAttrs

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object aria.type

Members list

Value members

Concrete methods

def ariaAttr[V](name: String, codec: Codec[V, String]): AriaAttr[V]

Create ARIA attribute (Note: for HTML attrs, use L.htmlAttr)

Create ARIA attribute (Note: for HTML attrs, use L.htmlAttr)

Type parameters

V
  • value type for this attr in Scala

Value parameters

codec
  • used to encode V into String, e.g. StringAsIsCodec
name
  • suffix of the attribute, without "aria-" prefix, e.g. "labelledby"

Attributes

protected def boolAsTrueFalseAriaAttr(name: String): AriaAttr[Boolean]
protected def doubleAriaAttr(name: String): AriaAttr[Double]
protected def intAriaAttr(name: String): AriaAttr[Int]
protected def stringAriaAttr(name: String): AriaAttr[String]

Concrete fields

lazy val activeDescendant: AriaAttr[String]

Identifies the currently active descendant of a composite widget.

Identifies the currently active descendant of a composite widget.

aria-activedescendant @ MDN

Attributes

lazy val atomic: AriaAttr[Boolean]

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. See related relevant.

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. See related relevant.

aria-atomic @ MDN

Attributes

lazy val autoComplete: AriaAttr[String]

Indicates whether user input completion suggestions are provided.

Indicates whether user input completion suggestions are provided.

Enumerated: "inline" | "list" | "both" | "none" (default)

aria-autocomplete @ MDN

Attributes

lazy val busy: AriaAttr[Boolean]

Indicates whether an element, and its subtree, are currently being updated.

Indicates whether an element, and its subtree, are currently being updated.

aria-busy @ MDN

Attributes

lazy val checked: AriaAttr[String]

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See related pressed and selected.

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See related pressed and selected.

Enumerated: Tristate – "true" | "false" | "mixed" | undefined (default)

  • undefined means the element does not support being checked

aria-checked @ MDN

Attributes

lazy val controls: AriaAttr[String]

Identifies the element (or elements) whose contents or presence are controlled by the current element. See related owns.

Identifies the element (or elements) whose contents or presence are controlled by the current element. See related owns.

aria-controls @ MDN

Attributes

lazy val current: AriaAttr[String]

Indicates the element that represents the current item within a container or set of related elements.

Indicates the element that represents the current item within a container or set of related elements.

Enumerated: "page" | "step" | "location" | "date" | "time" | "true" | "false" (default)

aria-current @ MDN

Attributes

lazy val describedBy: AriaAttr[String]

Identifies the element (or elements) that describes the object. See related labelledBy.

Identifies the element (or elements) that describes the object. See related labelledBy.

aria-describedby @ MDN

Attributes

lazy val disabled: AriaAttr[Boolean]

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See related hidden and readOnly.

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See related hidden and readOnly.

aria-disabled @ MDN

Attributes

lazy val dropEffect: AriaAttr[String]

Indicates what functions can be performed when the dragged object is released on the drop target. This allows assistive technologies to convey the possible drag options available to users, including whether a pop-up menu of choices is provided by the application. Typically, drop effect functions can only be provided once an object has been grabbed for a drag operation as the drop effect functions available are dependent on the object being dragged.

Indicates what functions can be performed when the dragged object is released on the drop target. This allows assistive technologies to convey the possible drag options available to users, including whether a pop-up menu of choices is provided by the application. Typically, drop effect functions can only be provided once an object has been grabbed for a drag operation as the drop effect functions available are dependent on the object being dragged.

Enumerated: "copy" | "move" | "link" | "execute" | "popup" | "none" (default)

aria-dropeffect @ MDN

Attributes

lazy val expanded: AriaAttr[Boolean]

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-expanded @ MDN

Attributes

lazy val flowTo: AriaAttr[String]

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-flowto @ MDN

Attributes

lazy val grabbed: AriaAttr[Boolean]

Indicates an element's "grabbed" state in a drag-and-drop operation.

Indicates an element's "grabbed" state in a drag-and-drop operation.

aria-grabbed @ MDN

Attributes

lazy val hasPopup: AriaAttr[Boolean]

Indicates that the element has a popup context menu or sub-level menu.

Indicates that the element has a popup context menu or sub-level menu.

aria-haspopup @ MDN

Attributes

lazy val hidden: AriaAttr[Boolean]

Indicates that the element and all of its descendants are not visible or perceivable to any user as implemented by the author. See related disabled.

Indicates that the element and all of its descendants are not visible or perceivable to any user as implemented by the author. See related disabled.

aria-hidden @ MDN

Attributes

lazy val invalid: AriaAttr[String]

Indicates the entered value does not conform to the format expected by the application.

Indicates the entered value does not conform to the format expected by the application.

Enumerated: "grammar" | "spelling" | "true" | "false" (default)

aria-invalid @ MDN

Attributes

lazy val label: AriaAttr[String]

Defines a string value that labels the current element. See related labelledBy.

Defines a string value that labels the current element. See related labelledBy.

aria-label @ MDN

Attributes

lazy val labelledBy: AriaAttr[String]

Identifies the element (or elements) that labels the current element. See related label and describedBy.

Identifies the element (or elements) that labels the current element. See related label and describedBy.

aria-labelledby @ MDN

Attributes

lazy val level: AriaAttr[Int]

Defines the hierarchical level of an element within a structure.

Defines the hierarchical level of an element within a structure.

aria-level @ MDN

Attributes

lazy val live: AriaAttr[String]

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Enumerated: "polite" | "assertive" | "off" (default)

aria-live @ MDN

Attributes

lazy val multiLine: AriaAttr[Boolean]

Indicates whether a text box accepts multiple lines of input or only a single line.

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiline @ MDN

Attributes

lazy val multiSelectable: AriaAttr[Boolean]

Indicates that the user may select more than one item from the current selectable descendants.

Indicates that the user may select more than one item from the current selectable descendants.

aria-multiselectable @ MDN

Attributes

lazy val orientation: AriaAttr[String]

Indicates whether the element and orientation is horizontal or vertical.

Indicates whether the element and orientation is horizontal or vertical.

Enumerated: "vertical" | "horizontal" (default)

aria-orientation @ MDN

Attributes

lazy val owns: AriaAttr[String]

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. See related controls.

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. See related controls.

aria-owns @ MDN

Attributes

lazy val posInSet: AriaAttr[Int]

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See related setSize.

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See related setSize.

aria-posinset @ MDN

Attributes

lazy val pressed: AriaAttr[String]

Indicates the current "pressed" state of toggle buttons. See related checked and selected.

Indicates the current "pressed" state of toggle buttons. See related checked and selected.

Enumerated: Tristate – "true" | "false" | "mixed" | undefined (default)

  • undefined means the element does not support being pressed

aria-pressed @ MDN

Attributes

lazy val readOnly: AriaAttr[Boolean]

Indicates that the element is not editable, but is otherwise operable. See related disabled.

Indicates that the element is not editable, but is otherwise operable. See related disabled.

aria-readonly @ MDN

Attributes

lazy val relevant: AriaAttr[String]

Indicates what user agent change notifications (additions, removals, etc.) assistive technologies will receive within a live region. See related atomic.

Indicates what user agent change notifications (additions, removals, etc.) assistive technologies will receive within a live region. See related atomic.

Enumerated: "additions" | "removals" | "text" | "all" | "additions text" (default)

aria-relevant @ MDN

Attributes

lazy val required: AriaAttr[Boolean]

Indicates that user input is required on the element before a form may be submitted.

Indicates that user input is required on the element before a form may be submitted.

aria-required @ MDN

Attributes

lazy val selected: AriaAttr[Boolean]

Indicates the current "selected" state of various widgets. See related checked and pressed.

Indicates the current "selected" state of various widgets. See related checked and pressed.

aria-selected @ MDN

Attributes

lazy val setSize: AriaAttr[Int]

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See related posInSet.

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. See related posInSet.

aria-setsize @ MDN

Attributes

lazy val sort: AriaAttr[String]

Indicates if items in a table or grid are sorted in ascending or descending order.

Indicates if items in a table or grid are sorted in ascending or descending order.

Enumerated: "ascending" | "descending" | "other" | "none" (default)

aria-sort @ MDN

Attributes

lazy val valueMax: AriaAttr[Double]

Defines the maximum allowed value for a range widget.

Defines the maximum allowed value for a range widget.

aria-valuemax @ MDN

Attributes

lazy val valueMin: AriaAttr[Double]

Defines the minimum allowed value for a range widget.

Defines the minimum allowed value for a range widget.

aria-valuemin @ MDN

Attributes

lazy val valueNow: AriaAttr[Double]

Defines the current value for a range widget. See related valueText.

Defines the current value for a range widget. See related valueText.

aria-valuenow @ MDN

Attributes

lazy val valueText: AriaAttr[String]

Defines the human readable text alternative of aria-valuenow for a range widget.

Defines the human readable text alternative of aria-valuenow for a range widget.

aria-valuetext @ MDN

Attributes