Clipboard API is the next-generation clipboard operation technique, which is extra highly effective and cheap than the normal Doc.execCommand() technique. All its operations are asynchronous and return Promise objects with out inflicting web page jams. Furthermore, it may possibly put arbitrary content material (akin to photos) into the clipboard. The navigator.clipboard property returns the Clipboard object, and all operations are carried out by way of this object.
const clipboardObj = navigator.clipboard;
If the navigator.clipboard property returns undefined, it signifies that the present browser doesn’t help this API (you’ll be able to see the complete compatibly desk on Can I exploit…). Since customers could put delicate knowledge (akin to passwords) on the clipboard, permitting scripts to learn them arbitrarily will trigger safety dangers, so this API has extra safety restrictions. To begin with, the Chrome browser stipulates that solely HTTPS protocol pages can use this API. Nevertheless, the event atmosphere (localhost) permits using non-encrypted protocols. Secondly, the person’s permission must be clearly obtained when calling. The precise implementation of permissions makes use of the Permissions API. There are two permissions associated to the clipboard: clipboard-write (write permission) and clipboard-read (learn permission). The “write permission” is mechanically granted to the script, and the “learn permission” have to be explicitly granted by the person. In different phrases, the script could be mechanically accomplished when writing to the clipboard, however when studying the clipboard, the browser will pop up a dialog field asking whether or not the person agrees to learn.
As well as, it must be famous that what the script reads is all the time the clipboard of the present web page. One downside that this brings is that if you happen to paste the related code into the developer instrument and run it straight, an error could also be reported as a result of the present web page right now is the window of the developer instrument, not an internet web page.
In the event you paste the above code into the developer instrument and run it, an error shall be reported. As a result of when the code is working, the developer instrument window is the present web page, and there’s no DOM interface that the Clipboard API will depend on this web page. One answer is to place the related code in setTimeout() to delay working, and shortly click on on the web page window of the browser earlier than calling the perform to show it into the present web page.
After the above code is pasted into the developer instrument to run, shortly click on on the web page window of the webpage to make it the present web page, in order that no error shall be reported.
Clipboard object
clipboard.readText()
The clipboard.readText() technique is used to repeat the textual content knowledge within the clipboard.
Within the above instance, after the person clicks on the web page, the textual content within the clipboard shall be output. Be aware that the browser will pop up a dialog field right now, asking the person whether or not to agree with the script to learn the clipboard.
If the person disagrees, the script will report an error. Right now, you need to use the strive...catch construction to deal with errors.
clipboard.learn()
The clipboard.learn() technique is used to repeat the information within the clipboard, which could be textual content knowledge or binary knowledge (akin to photos). This technique requires express permission from the person. This technique returns a Promise object. As soon as the state of the article turns into resolved, an array could be obtained, and every array member is an occasion of a ClipboardItem object.
The ClipboardItem object represents a single clip merchandise and every clip merchandise has a clipboardItem.sorts property and a clipboardItem.getType() technique. The clipboardItem.sorts property returns an array whose members are the MIME sorts out there for the clip merchandise. For instance, a clip merchandise could be pasted in HTML format or in plain textual content format. Then it has two MIME sorts (textual content/html and textual content/plain). The clipboardItem.getType(kind) technique is used to learn the information of the clip merchandise and returns a Promise object. This technique accepts the MIME kind of the clip merchandise as a parameter and returns the information of that kind. This parameter is required, in any other case, an error shall be reported.
clipboard.writeText()
The clipboard.writeText() technique is used to put in writing textual content content material to the clipboard.
The above instance is that after the person clicks on the internet web page, the script writes textual content knowledge to the clipboard. This technique doesn’t require person permission, however it’s best to place it in strive...catch to stop errors.
clipboard.write()
The clipboard.write() technique is used to put in writing arbitrary knowledge to the clipboard, which could be textual content knowledge or binary knowledge. This technique accepts a ClipboardItem occasion as a parameter, which represents the information written to the clipboard.
Within the above instance, the script writes an image to the clipboard. Be aware that the Chrome browser presently (till this author writes this text) solely helps writing photographs in PNG format. clipboardItem() is a constructor natively offered by the browser to generate an occasion of clipboardItem. It accepts an object as a parameter. The important thing identify of the article is the MIME kind of the information, and the important thing worth is the information itself. The next instance is to put in writing the worth of the identical clip merchandise in a number of codecs to the clipboard, one is textual content knowledge, and the opposite is binary knowledge for pasting on completely different events.
