Element: cut event
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2017.
The cut
event of the Clipboard API is fired when the user has initiated a "cut" action through the browser's user interface.
If the user attempts a cut action on uneditable content, the cut
event still fires but the event object contains no data.
The event's default action is to copy the current selection (if any) to the system clipboard and remove it from the document.
A handler for this event can modify the clipboard contents by calling setData(format, data)
on the event's ClipboardEvent.clipboardData
property, and cancelling the default action using event.preventDefault()
.
Note though that cancelling the default action will also prevent the document from being updated. So an event handler which wants to emulate the default action for "cut" while modifying the clipboard must also manually remove the selection from the document.
The handler cannot read the clipboard data.
It's possible to construct and dispatch a synthetic cut
event, but this will not affect the system clipboard or the document's contents.
This event bubbles, is cancelable and is composed.
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
addEventListener("cut", (event) => {});
oncut = (event) => {};
Event type
A ClipboardEvent
. Inherits from Event
.
Examples
Live example
HTML
<div class="source" contenteditable="true">Cut text from this box.</div>
<div class="target" contenteditable="true">And paste it into this one.</div>
JavaScript
const source = document.querySelector("div.source");
source.addEventListener("cut", (event) => {
const selection = document.getSelection();
event.clipboardData.setData("text/plain", selection.toString().toUpperCase());
selection.deleteFromDocument();
event.preventDefault();
});
Result
Specifications
Specification |
---|
Clipboard API and events # clipboard-event-cut |
HTML Standard # handler-oncut |
Browser compatibility
BCD tables only load in the browser