goog.a11y.aria

Provided By	`goog.a11y.aria`

Asserts that the element has a role set if it's not an HTML element whose semantics is well supported by most screen readers. Only to be used internally by the ARIA library in goog.a11y.aria.*.

Parameters

`element`	`Element`
	The element to assert an ARIA role set.
`allowedRoles`	`IArrayLike<string>`
	The child roles of the roles.

VIEW SOURCE

Returns the activedescendant element for the input element by using the activedescendant ARIA property of the given element.

Parameters

`element`	`Element`
	DOM node to get activedescendant element for.

Returns

(Element|null)

DOM node of the activedescendant, if found.

VIEW SOURCE

Gets the label of the given element.

Parameters

`element`	`Element`
	DOM node to get label from.

Returns

string

label The label.

VIEW SOURCE

Gets role of an element.

Parameters

`element`	`Element`
	DOM element to get role of.

Returns

(goog.a11y.aria.Role|null)

ARIA Role name.

VIEW SOURCE

Gets value of specified state or property.

Parameters

`element`	`Element`
	DOM node to get state from.
`stateName`	`string`
	State name.

Returns

string

Value of the state attribute.

VIEW SOURCE

Gets the boolean value of an ARIA state/property.

Parameters

`element`	`Element`
	The element to get the ARIA state for.
`stateName`	`string`
	the ARIA state name.

Returns

(boolean|null)

Boolean value for the ARIA state value or null if the state value is not 'true', not 'false', or not set.

VIEW SOURCE

Gets the number value of an ARIA state/property.

Parameters

`element`	`Element`
	The element to get the ARIA state for.
`stateName`	`string`
	the ARIA state name.

Returns

(number|null)

Number value for the ARIA state value or null if the state value is not a number or not set.

VIEW SOURCE

Gets the string value of an ARIA state/property.

Parameters

`element`	`Element`
	The element to get the ARIA state for.
`stateName`	`string`
	the ARIA state name.

Returns

(string|null)

String value for the ARIA state value or null if the state value is empty string or not set.

VIEW SOURCE

Gets array of strings value of the specified state or property for the element. Only to be used internally by the ARIA library in goog.a11y.aria.*.

Parameters

`element`	`Element`
	DOM node to get state from.
`stateName`	`goog.a11y.aria.State`
	State name.

Returns

IArrayLike<string>

string Array value of the state attribute.

VIEW SOURCE

Returns true if element has an ARIA state/property, false otherwise.

Parameters

`element`	`Element`
	The element to get the ARIA state for.
`stateName`	`string`
	the ARIA state name.

Returns

boolean

VIEW SOURCE

Returns whether the element has a container ARIA role. Container roles are ARIA roles that use the aria-activedescendant property to manage their active descendants or children. See #aria-activedescendant for more information.

Parameters

`element`	`Element`

Returns

boolean

VIEW SOURCE

Removes role of an element.

Parameters

`element`	`Element`
	DOM element to remove the role from.

VIEW SOURCE

Remove the state or property for the element.

Parameters

`element`	`Element`
	DOM node where we set state.
`stateName`	`goog.a11y.aria.State`
	State name.

VIEW SOURCE

Sets the activedescendant ARIA property value for an element. If the activeElement is not null, it should have an id set.

Parameters

`element`	`Element`
	DOM node to set activedescendant ARIA property to.
`activeElement`	`(Element\|null)`
	DOM node being set as activedescendant.

VIEW SOURCE

Sets the label of the given element.

Parameters

`element`	`Element`
	DOM node to set label to.
`label`	`string`
	The label to set.

VIEW SOURCE

Sets the role of an element. If the roleName is empty string or null, the role for the element is removed. We encourage clients to call the goog.a11y.aria.removeRole method instead of setting null and empty string values. Special handling for this case is added to ensure backword compatibility with existing code.

Parameters

`element`	`Element`
	DOM node to set role of.
`roleName`	`string`
	role name(s).

VIEW SOURCE

Sets the state or property of an element.

Parameters

`element`	`Element`
	DOM node where we set state.
`stateName`	`string`
	State attribute being set. Automatically adds prefix 'aria-' to the state name if the attribute is not an extra attribute.
`value`	`(string\|boolean\|number\|Array<string>)`
	Value for the state attribute.

VIEW SOURCE

Toggles the ARIA attribute of an element. Meant for attributes with a true/false value, but works with any attribute. If the attribute does not have a true/false value, the following rules apply: A not empty attribute will be removed. An empty attribute will be set to true.

Parameters

`el`	`Element`
	DOM node for which to set attribute.
`attr`	`string`
	ARIA attribute being set. Automatically adds prefix 'aria-' to the attribute name if the attribute is not an extra attribute.

VIEW SOURCE

goog.a11y.aria

Functions

assertRoleIsSetInternalUtil( `element`, `allowedRoles` ) `→` `void`

getActiveDescendant( `element` ) `→` `(Element|null)`

getLabel( `element` ) `→` `string`

getRole( `element` ) `→` `(goog.a11y.aria.Role|null)`

getState( `element`, `stateName` ) `→` `string`

getStateBoolean( `element`, `stateName` ) `→` `(boolean|null)`

getStateNumber( `element`, `stateName` ) `→` `(number|null)`

getStateString( `element`, `stateName` ) `→` `(string|null)`

getStringArrayStateInternalUtil( `element`, `stateName` ) `→` `IArrayLike<string>`

hasState( `element`, `stateName` ) `→` `boolean`

isContainerRole( `element` ) `→` `boolean`

removeRole( `element` ) `→` `void`

removeState( `element`, `stateName` ) `→` `void`

setActiveDescendant( `element`, `activeElement` ) `→` `void`

setLabel( `element`, `label` ) `→` `void`

setRole( `element`, `roleName` ) `→` `void`

setState( `element`, `stateName`, `value` ) `→` `void`

toggleState( `el`, `attr` ) `→` `void`

Classes

Enumerations

goog.a11y.aria

Functions

assertRoleIsSetInternalUtil( element, allowedRoles ) → void

getActiveDescendant( element ) → (Element|null)

getLabel( element ) → string

getRole( element ) → (goog.a11y.aria.Role|null)

getState( element, stateName ) → string

getStateBoolean( element, stateName ) → (boolean|null)

getStateNumber( element, stateName ) → (number|null)

getStateString( element, stateName ) → (string|null)

getStringArrayStateInternalUtil( element, stateName ) → IArrayLike<string>

hasState( element, stateName ) → boolean

isContainerRole( element ) → boolean

removeRole( element ) → void

removeState( element, stateName ) → void

setActiveDescendant( element, activeElement ) → void

setLabel( element, label ) → void

setRole( element, roleName ) → void

setState( element, stateName, value ) → void

toggleState( el, attr ) → void

Classes

Enumerations

assertRoleIsSetInternalUtil( `element`, `allowedRoles` ) `→` `void`

getActiveDescendant( `element` ) `→` `(Element|null)`

getLabel( `element` ) `→` `string`

getRole( `element` ) `→` `(goog.a11y.aria.Role|null)`

getState( `element`, `stateName` ) `→` `string`

getStateBoolean( `element`, `stateName` ) `→` `(boolean|null)`

getStateNumber( `element`, `stateName` ) `→` `(number|null)`

getStateString( `element`, `stateName` ) `→` `(string|null)`

getStringArrayStateInternalUtil( `element`, `stateName` ) `→` `IArrayLike<string>`

hasState( `element`, `stateName` ) `→` `boolean`

isContainerRole( `element` ) `→` `boolean`

removeRole( `element` ) `→` `void`

removeState( `element`, `stateName` ) `→` `void`

setActiveDescendant( `element`, `activeElement` ) `→` `void`

setLabel( `element`, `label` ) `→` `void`

setRole( `element`, `roleName` ) `→` `void`

setState( `element`, `stateName`, `value` ) `→` `void`

toggleState( `el`, `attr` ) `→` `void`