If a screenreader reads some content, and then that content changes, the user may not be aware that anything happened. This is where live regions come in. Live regions (and associated properties) can tell the screenreader what relevant changing information to present to the user, and how urgently the information is needed.
Learn more about how to use live regions here.
atomic : Basics.Bool -> Html.Attribute msg
Supported for all elements.
This property indicates that a region is live, and may change even when the region doesn't have focus. When True
, all the contents of the element will be presented to the user.
busy : Basics.Bool -> Html.Attribute msg
Supported for all elements.
When set to True
, this is the aria equivalent of a loading spinner--indicates that stuff is changing/is not ready for interaction/reading-off yet.
polite : Html.Attribute msg
Supported by all elements.
When the region's contents change, assistive technologies will wait for a good moment to interrupt and do so politely with the update.
assertive : Html.Attribute msg
Supported by all elements.
Updates to the region will cause the assistive technologies to immediately interrupt the user with the big news.
off : Html.Attribute msg
Use Live.off to suppress updates that otherwise would be announced to the user due to the element's role.
livePolite : Html.Attribute msg
Identical to polite
. Included for backwards-compatibility. A future version of the library will likely remove this helper.
liveAssertive : Html.Attribute msg
Identical to assertive
. Included for backwards-compatibility. A future version of the library will likely remove this helper.
relevantAdditions : Html.Attribute msg
Supported by live regions.
Keep track of additions to the live region.
relevantAdditionsText : Html.Attribute msg
Supported by live regions.
Keep track of node additions to the live region and text additions.
relevantAll : Html.Attribute msg
Supported by live regions.
Keep track of everything to occur in the live region. Use sparingly!
relevantRemovals : Html.Attribute msg
Supported by live regions.
Keep track of text or node removals. Use sparingly!
relevantText : Html.Attribute msg
Supported by live regions.
Keep track of text additions to the live region.