spAriaUtil : client

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 1 minute de lecture
  • L’API spAriaUtil fournit des méthodes pour afficher les messages sur un lecteur d’écran.

    Cette API est un service d’angle que vous pouvez utiliser dans les Portail de services scripts clients de widget.

    spAriaUtil : sendLiveMessage(Message de chaîne)

    Annoncer un message à un lecteur d’écran.

    La méthode sendLiveMessage() injecte du texte dans une région aria-live sur la page. Le paramètre par défaut pour une région aria-live est assertif, ce qui signifie que les messages sont annoncés immédiatement. Cela peut ennuyer et dérouter les utilisateurs s’il est utilisé trop fréquemment.

    Tableau 1. Paramètres
    Nom Type Description
    message Chaîne Message à afficher.
    Tableau 2. Renvoie
    Type Description
    nul
    function(spAriaUtil) {
      /* widget controller */
    
      spAriaUtil.sendLiveMessage('Hello world!');
    }