Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

spAriaUtil- Client

The spAriaUtil API provides methods to show messages on a screen reader.

This API is an angular service that you can use in Service Portal widget client scripts.

Parent Topic:Client API reference

spAriaUtil - sendLiveMessage(String message)

Announce a message to a screen reader.

The sendLiveMessage() method injects text into an aria-live region on the page. The default setting for an aria-live region is assertive, which means that messages are announced immediately. This can annoy and confuse users if used too frequently.

NameTypeDescription
messageStringThe message to be shown.
TypeDescription
void 
function(spAriaUtil) {
  /* widget controller */

  spAriaUtil.sendLiveMessage('Hello world!');
}