Element: beforeinput event
UI Events
UI Events
The DOM beforeinput event fires when the value of an input or textarea element is about to be modified. But in contrast to the input event, it does not fire on the select element. The event also applies to elements with contenteditable enabled, and to any element when designMode is turned on.
This allows web apps to override text edit behavior before the browser modifies the DOM tree, and provides more control over input events to improve performance.
In the case of contenteditable and designMode, the event target is the editing host. If these properties apply to multiple elements, the editing host is the nearest ancestor element whose parent isn't editable.
[!NOTE] Not every user modification results in
beforeinputfiring. Also the event may fire but be non-cancelable. This may happen when the modification is done by autocomplete, by accepting a correction from a spell checker, by password manager autofill, by IME, or in other ways. The details vary by browser and OS. To override the edit behavior in all situations, the code needs to handle theinputevent and possibly revert any modifications that were not handled by thebeforeinputhandler. See bugs 1673558 and 1763669.
Syntax
Use the event name in addEventListener():
addEventListener("beforeinput", (event) => { })
Alternatively, assign to the event handler property of the interface:
onbeforeinput = (event) => { }
Event type
An InputEvent. Inherits from UIEvent.
InputEvent
Examples
Feature Detection
The following function returns true if beforeinput, and thus getTargetRanges, is supported.
function isBeforeInputEventAvailable() {
return (
window.InputEvent &&
typeof InputEvent.prototype.getTargetRanges === "function"
);
}
Simple logger
This example logs the current value of the element, immediately before replacing that value with the new one applied to the input element.
HTML
<input placeholder="Enter some text" name="name" />
<p id="values"></p>
JavaScript
const input = document.querySelector("input");
const log = document.getElementById("values");
input.addEventListener("beforeinput", updateValue);
function updateValue(e) {
log.textContent = e.target.value;
}
Result
Simple_logger
Specifications
Browser compatibility
See also
- Related event: input