spAriaUtil : client

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture
  • L’API spAriaUtil fournit des méthodes pour afficher des messages sur un lecteur d’écran.

    Cette API est un service angulaire que vous pouvez utiliser dans Portail de services les 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 de la page. Le paramètre par défaut d’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 Le message à afficher.
    Tableau 2. Renvoie
    Type Description
    nul
    function(spAriaUtil) {
      /* widget controller */
    
      spAriaUtil.sendLiveMessage('Hello world!');
    }