Skip to main content
Version: 1.x

@microsoft/fast-foundation > ARIAGlobalStatesAndProperties

ARIAGlobalStatesAndProperties class

Some states and properties are applicable to all host language elements regardless of whether a role is applied. The following global states and properties are supported by all roles and by all base markup elements. https://www.w3.org/TR/wai-aria-1.1/#global_states

This is intended to be used as a mixin. Be sure you extend FASTElement.

Signature:
export declare class ARIAGlobalStatesAndProperties 

Properties

PropertyModifiersTypeDescription
ariaAtomic"true" | "false" | string | nullIndicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. https://www.w3.org/TR/wai-aria-1.1/#aria-atomic
ariaBusy"true" | "false" | string | nullIndicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. https://www.w3.org/TR/wai-aria-1.1/#aria-busy
ariaControlsstring | nullIdentifies the element (or elements) whose contents or presence are controlled by the current element.https://www.w3.org/TR/wai-aria-1.1/#aria-controls
ariaCurrent"page" | "step" | "location" | "date" | "time" | "true" | "false" | string | nullIndicates the element that represents the current item within a container or set of related elements.https://www.w3.org/TR/wai-aria-1.1/#aria-current
ariaDescribedbystring | nullIdentifies the element (or elements) that describes the object.https://www.w3.org/TR/wai-aria-1.1/#aria-describedby
ariaDetailsstring | nullIdentifies the element that provides a detailed, extended description for the object.https://www.w3.org/TR/wai-aria-1.1/#aria-details
ariaDisabled"true" | "false" | string | nullIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.https://www.w3.org/TR/wai-aria-1.1/#aria-disabled
ariaErrormessagestring | nullIdentifies the element that provides an error message for the object.https://www.w3.org/TR/wai-aria-1.1/#aria-errormessage
ariaFlowtostring | nullIdentifies 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.https://www.w3.org/TR/wai-aria-1.1/#aria-flowto
ariaHaspopup"false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | string | nullIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.https://www.w3.org/TR/wai-aria-1.1/#aria-haspopup
ariaHidden"false" | "true" | string | nullIndicates whether the element is exposed to an accessibility APIhttps://www.w3.org/TR/wai-aria-1.1/#aria-hidden
ariaInvalid"false" | "true" | "grammar" | "spelling" | string | nullIndicates the entered value does not conform to the format expected by the application.https://www.w3.org/TR/wai-aria-1.1/#aria-invalid
ariaKeyshortcutsstring | nullIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.https://www.w3.org/TR/wai-aria-1.1/#aria-keyshortcuts
ariaLabelstring | nullDefines a string value that labels the current element.https://www.w3.org/TR/wai-aria-1.1/#aria-label
ariaLabelledbystring | nullIdentifies the element (or elements) that labels the current element.https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby
ariaLive"assertive" | "off" | "polite" | string | nullIndicates 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.https://www.w3.org/TR/wai-aria-1.1/#aria-live
ariaOwnsstring | nullIdentifies 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.https://www.w3.org/TR/wai-aria-1.1/#aria-owns
ariaRelevant"additions" | "additions text" | "all" | "removals" | "text" | string | nullIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.https://www.w3.org/TR/wai-aria-1.1/#aria-relevant
ariaRoledescriptionstring | nullDefines a human-readable, author-localized description for the role of an element.https://www.w3.org/TR/wai-aria-1.1/#aria-roledescription