Clipboard API is the next-generation clipboard operation methodology, which is extra highly effective and cheap than the standard Doc.execCommand() methodology. All its operations are asynchronous and return Promise objects with out inflicting web page jams. Furthermore, it may possibly put arbitrary content material (comparable 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 assist this API (you possibly can see the total compatibly desk on Can I take advantage of…). Since customers might put delicate information (comparable 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. Nonetheless, the event atmosphere (localhost) permits the usage of non-encrypted protocols. Secondly, the consumer’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 consumer. In different phrases, the script may 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 consumer agrees to learn.
As well as, it needs to be famous that what the script reads is at all times the clipboard of the present web page. One downside that this brings is that when you paste the related code into the developer instrument and run it immediately, an error could also be reported as a result of the present web page at the moment is the window of the developer instrument, not an online web page.
Should you paste the above code into the developer instrument and run it, an error will probably be reported. As a result of when the code is operating, 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 resolution is to place the related code in setTimeout() to delay operating, and shortly click on on the web page window of the browser earlier than calling the operate 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 will probably be reported.
Clipboard object
clipboard.readText()
The clipboard.readText() methodology is used to repeat the textual content information within the clipboard.
Within the above instance, after the consumer clicks on the web page, the textual content within the clipboard will probably be output. Be aware that the browser will pop up a dialog field at the moment, asking the consumer whether or not to agree with the script to learn the clipboard.
If the consumer disagrees, the script will report an error. Right now, you should use the attempt...catch construction to deal with errors.
clipboard.learn()
The clipboard.learn() methodology is used to repeat the information within the clipboard, which may be textual content information or binary information (comparable to photos). This methodology requires express permission from the consumer. This methodology returns a Promise object. As soon as the state of the article turns into resolved, an array may 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() methodology. The clipboardItem.sorts property returns an array whose members are the MIME sorts out there for the clip merchandise. For instance, a clip merchandise may 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) methodology is used to learn the information of the clip merchandise and returns a Promise object. This methodology 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 will probably be reported.
clipboard.writeText()
The clipboard.writeText() methodology is used to put in writing textual content content material to the clipboard.
The above instance is that after the consumer clicks on the internet web page, the script writes textual content information to the clipboard. This methodology doesn’t require consumer permission, however it’s best to place it in attempt...catch to stop errors.
clipboard.write()
The clipboard.write() methodology is used to put in writing arbitrary information to the clipboard, which may be textual content information or binary information. This methodology 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 supplied 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 information, and the opposite is binary information for pasting on completely different events.
