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.
Bubbles | No |
---|---|
Cancelable | No |
Interface | MessageEvent |
Event handler property | onmessage |
Examples
Suppose a script sends a message to a different browsing context, such as another <iframe>
, using code like this:
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:
window.addEventListener('message', (event) => {
console.log(`Received message: ${event.data}`);
});
Alternatively the listener could use the onmessage
event handler property:
window.onmessage = (event) => {
console.log(`Received message: ${event.data}`);
};
Specifications
Specification | Status |
---|---|
HTML Living Standard | Living Standard |
Browser compatibility
BCD tables only load in the browser
See also
- Related events:
messageerror
. Window.postMessage()
.