Variable AccessibilityUtilsConst

Type declaration

• getAriaDescribedBy:function

  • getAriaDescribedBy(element): null | string

  • Gets the ARIA described by attribute of an element

    Parameters

    • element: Element

      The DOM element to check

    Returns null | string

    The value of aria-describedby attribute or null if not set

    Example

    const element = document.querySelector('.input');
    const describedBy = AccessibilityUtils.getAriaDescribedBy(element);
    Copy

• setAriaDescribedBy:function

  • setAriaDescribedBy(element, describedBy): void

  • Sets the ARIA described by attribute of an element

    Parameters

    • element: Element

      The DOM element to modify
    • describedBy: string

      The ID(s) of the element(s) that describe this element

    Returns void

    Example

    const input = document.querySelector('.input');
    const helpText = document.querySelector('.help-text');
    AccessibilityUtils.setAriaDescribedBy(input, helpText.id);
    Copy

• getAriaExpanded:function

  • getAriaExpanded(element): null | boolean

  • Gets the ARIA expanded state of an element

    Parameters

    • element: Element

      Element to check

    Returns null | boolean

    ARIA expanded state

• setAriaExpanded:function

  • setAriaExpanded(element, expanded): void

  • Sets the ARIA expanded state of an element

    Parameters

    • element: Element

      Element to modify
    • expanded: boolean

      ARIA expanded state to set

    Returns void

• getAriaHidden:function

  • getAriaHidden(element): null | boolean

  • Gets the ARIA hidden state of an element

    Parameters

    • element: Element

      Element to check

    Returns null | boolean

    ARIA hidden state

• setAriaHidden:function

  • setAriaHidden(element, hidden): void

  • Sets the ARIA hidden state of an element

    Parameters

    • element: Element

      Element to modify
    • hidden: boolean

      ARIA hidden state to set

    Returns void

• getAriaInvalid:function

  • getAriaInvalid(element): null | boolean

  • Gets the ARIA invalid state of an element

    Parameters

    • element: Element

      Element to check

    Returns null | boolean

    ARIA invalid state

• setAriaInvalid:function

  • setAriaInvalid(element, invalid): void

  • Sets the ARIA invalid state of an element

    Parameters

    • element: Element

      Element to modify
    • invalid: boolean

      ARIA invalid state to set

    Returns void

• getAriaLabel:function

  • getAriaLabel(element): null | string

  • Gets the ARIA label of an element

    Parameters

    • element: Element

      Element to check

    Returns null | string

    ARIA label

• setAriaLabel:function

  • setAriaLabel(element, label): void

  • Sets the ARIA label of an element

    Parameters

    • element: Element

      Element to modify
    • label: string

      ARIA label to set

    Returns void

• getAriaRequired:function

  • getAriaRequired(element): null | boolean

  • Gets the ARIA required state of an element

    Parameters

    • element: Element

      Element to check

    Returns null | boolean

    ARIA required state

• setAriaRequired:function

  • setAriaRequired(element, required): void

  • Sets the ARIA required state of an element

    Parameters

    • element: Element

      Element to modify
    • required: boolean

      ARIA required state to set

    Returns void

• getAriaRole:function

  • getAriaRole(element): null | string

  • Gets the ARIA role of an element

    Parameters

    • element: Element

      Element to check

    Returns null | string

    ARIA role

• setAriaRole:function

  • setAriaRole(element, role): void

  • Sets the ARIA role of an element

    Parameters

    • element: Element

      Element to modify
    • role: string

      ARIA role to set

    Returns void

• blurElement:function

  • blurElement(element): void

  • Removes focus from an element

    Parameters

    • element: Element

      Element to blur

    Returns void

• focusElement:function

  • focusElement(element): void

  • Sets focus to an element

    Parameters

    • element: Element

      Element to focus

    Returns void

• focusFirstElement:function

  • focusFirstElement(container): void

  • Sets focus to the first focusable element in a container

    Parameters

    • container: Element

      Container element

    Returns void

• focusLastElement:function

  • focusLastElement(container): void

  • Sets focus to the last focusable element in a container

    Parameters

    • container: Element

      Container element

    Returns void

• focusNextElement:function

  • focusNextElement(currentElement): void

  • Sets focus to the next focusable element

    Parameters

    • currentElement: Element

      Current element

    Returns void

• focusPreviousElement:function

  • focusPreviousElement(currentElement): void

  • Sets focus to the previous focusable element

    Parameters

    • currentElement: Element

      Current element

    Returns void

• getFocusableElements:function

  • getFocusableElements(container): Element[]

  • Gets all focusable elements within a container

    Parameters

    • container: Element

      Container element

    Returns Element[]

    Array of focusable elements

• getFocusedElement:function

  • getFocusedElement(): null | Element

  • Gets the current focus element

    Returns null | Element

    Currently focused element

• isFocusable:function

  • isFocusable(element): boolean

  • Checks if an element is focusable

    Parameters

    • element: Element

      Element to check

    Returns boolean

    True if element is focusable

• trapFocus:function

  • trapFocus(container): (() => void)

  • Traps focus within a container element, typically used for modals or dialogs

    Parameters

    • container: Element

      The container element to trap focus within

    Returns (() => void)

    A function that removes the focus trap when called

    • • (): void

      • Returns void

    Example

    const modal = document.querySelector('.modal');
    const removeTrap = AccessibilityUtils.trapFocus(modal);
    
    // Later, when the modal is closed:
    removeTrap();
    Copy