ARIA: log role
{{AccessibilitySidebar}}
The log role is used to identify an element that creates a live region where new information is added in a meaningful order and old information may disappear.
Description
A log is a type of live region where new information is added in meaningful order and old information may disappear. Examples include chat logs, messaging history, game log, or an error log. In contrast to other live regions, in this role there is a relationship between the arrival of new items in the log and the reading order. The log contains a meaningful sequence and new information is added only to the end of the log, not at arbitrary points.
In contrast to other types of live region, a log is sequentially ordered and new information is only added to the end of the log. When this role is added to an element, the browser will send out an accessible log event to assistive technology products which can then notify the user about it.
By default, updates contain only the changes to the live region and these are announced when the user is idle. Elements with the role log have an implicit aria-live value of polite. Where the user needs to hear the entire live region upon a change aria-atomic="true" should be set. To have announcements made as soon as possible and where the user may be interrupted, aria-live="assertive" can be set for more aggressive updates.
Associated WAI-ARIA roles, states, and properties
-
aria-atomic- : Defines whether assistive technologies should present all, or only parts of, the changed region. Elements with the role
loghave an implicit aria-atomic value offalse.
- : Defines whether assistive technologies should present all, or only parts of, the changed region. Elements with the role
-
aria-live- : Defines when assistive technology should inform the user of updates to content. Elements with the role
loghave an implicit aria-live value ofpolite, meaning screen readers will announce changes inside the log when the user is idle.
- : Defines when assistive technology should inform the user of updates to content. Elements with the role
-
aria-labelandaria-labelledby- : The
logis required to have an accessible name. Usearia-labelledbyif a visible label is present, otherwise usearia-label.
- : The
Best Practices
With an area that has scrolling text, such as a stock ticker, the marquee role should be used instead.
Specifications
{{Specifications}}