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 July 2015.
Thecut event of theClipboard 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, thecut 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 canmodify the clipboard contents by callingsetData(format, data) on the event'sClipboardEvent.clipboardData property, and cancelling the default action usingevent.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 cannotread the clipboard data.
It's possible to construct and dispatch asyntheticcut event, but this will not affect the system clipboard or the document's contents.
This eventbubbles up the DOM tree, eventually toDocument andWindow, iscancelable and iscomposed.
In this article
Syntax
Use the event name in methods likeaddEventListener(), or set an event handler property.
addEventListener("cut", (event) => { })oncut = (event) => { }Event type
AClipboardEvent. Inherits fromEvent.
Examples
>Live example
HTML
<div contenteditable="true">Cut text from this box.</div><div contenteditable="true">And paste it into this one.</div>div.source,div.target { border: 1px solid gray; margin: 0.5rem; padding: 0.5rem; height: 1rem; background-color: #e9eef1;}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> # handler-oncut> |