BroadcastChannel : évènement message

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2022.

L'évènement message est déclenché sur un objet BroadcastChannel lorsqu'un message arrive sur le canal.

Syntaxe

Utilisez le nom de l'évènement dans les méthodes telles que addEventListener(), ou définissez un gestionnaire d'évènements.

js
addEventListener("message", (event) => {});
onmessage = (event) => {};

Type de l'évènement

Un MessageEvent. Hérite de l'interface Event.

Event MessageEvent

Propriété de l'évènement

En plus des propriétés listées ci-dessous, celles provenant de l'interface parente Event sont disponibles.

  • data Lecture seule
    • : Les données envoyées par l'émetteur du message.
  • origin Lecture seule
  • lastEventId Lecture seule
    • : Une chaîne représentant l'identifiant unique pour l'évènement.
  • source Lecture seule
  • ports Lecture seule
    • : Un tableau d'objets MessagePort représentant les ports associés au canal par lequel le message est envoyé (lorsque c'est approprié, par exemple, dans le canal de communication ou lorsqu'un message est envoyé à un worker partagé).

Exemples

Dans cet exemple, il y a un <iframe> « émetteur » qui diffuse le contenu du <textarea> lorsque l'utilisatrice ou l'utilisateur clique sur le bouton. Il y a deux iframes « récepteurs » qui écoutent le message diffusé et écrivent le résultat dans un élément <div>.

Émetteur

js
const canal = new BroadcastChannel("canal_exemple");
const commandeMessage = document.querySelector("#message");
const boutonDeDiffusion = document.querySelector("#broadcast-message");

boutonDeDiffusion.addEventListener("click", () => {
  canal.postMessage(commandeMessage.value);
});

Récepteur 1

js
const canal = new BroadcastChannel("canal_exemple");
canal.addEventListener("message", (event) => {
  recu.textContent = event.data;
});

Récepteur 2

js
const canal = new BroadcastChannel("canal_exemple");
canal.addEventListener("message", (event) => {
  recu.textContent = event.data;
});

Résultat

Spécifications

Specification
HTML
# event-message
HTML
# handler-broadcastchannel-onmessage

Compatibilité des navigateurs

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
message event

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
User must explicitly enable this feature.

Voir aussi