The message
event is fired on a Window
object when the window receives a message, for example from a call to Window.postMessage()
from another browsing context.
This event is not cancellable and does not bubble.
The message
event is fired on a Window
object when the window receives a message, for example from a call to Window.postMessage()
from another browsing context.
This event is not cancellable and does not bubble.
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("message", (event) => {}); onmessage = (event) => {};
A MessageEvent
. Inherits from Event
.
This interface also inherits properties from its parent, Event
.
MessageEvent.data
Read only
The data sent by the message emitter.
MessageEvent.origin
Read only
A string representing the origin of the message emitter.
MessageEvent.lastEventId
Read only
A string representing a unique ID for the event.
MessageEvent.source
Read only
A MessageEventSource
(which can be a WindowProxy, MessagePort
, or ServiceWorker
object) representing the message emitter.
MessageEvent.ports
Read only
An array of MessagePort
objects representing the ports associated with the channel the message is being sent through (where appropriate, e.g. in channel messaging or when sending a message to a shared worker).
Suppose a script sends a message to a different browsing context, such as another <iframe>
, using code like this:
js
const targetFrame = window.top.frames[1]; const targetOrigin = "https://example.org"; const windowMessageButton = document.querySelector("#window-message"); windowMessageButton.addEventListener("click", () => { targetFrame.postMessage("hello there", targetOrigin); });
The receiver can listen for the message using addEventListener()
with code like this:
js
window.addEventListener("message", (event) => { console.log(`Received message: ${event.data}`); });
Alternatively the listener could use the onmessage
event handler property:
js
window.onmessage = (event) => { console.log(`Received message: ${event.data}`); };
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
message_event |
60 | 12 | 9 | 8 | 47 | 4 | 60 | 60 | 9 | 47 | 4 | 8.0 |
messageerror
.Window.postMessage()
.
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Window/message_event