spAriaUtil - Client

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:1分
  • 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.

    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.

    表 : 1. Parameters
    Name Type Description
    message String The message to be shown.
    表 : 2. Returns
    Type Description
    void
    function(spAriaUtil) {
      /* widget controller */
    
      spAriaUtil.sendLiveMessage('Hello world!');
    }