ClipboardItem: supports() static method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The supports()
static method of the ClipboardItem
interface returns true
if the given MIME type is supported by the clipboard, and false
otherwise.
Note that the Clipboard API mandates support for plain text, HTML and PNG files.
The supports()
method will always return true
for these MIME types, so testing them is unnecessary.
Syntax
supports(type)
Parameters
type
-
A string, indicating the MIME type to test.
These MIME types are always supported:
text/plain
text/html
image/png
These MIME types may be supported:
image/svg+xml
- Custom MIME-type formats starting with
"web "
. The custom type (without the"web "
prefix), must have the correct formatting for a MIME type.
Return value
true
if the given MIME type is supported by the clipboard, false
otherwise.
Examples
Writing an image to the clipboard
The following example fetches an SVG image to a blob, and then writes it to the clipboard.
We use supports()
to check whether the "image/svg+xml"
MIME type is supported by the clipboard before fetching the image and writing it using clipboard.write()
.
We also wrap the whole function body in try..catch
statement to catch any other errors, such as ClipboardItem
itself not being supported.
async function writeClipImg() {
try {
if (ClipboardItem.supports("image/svg+xml")) {
const imgURL = "/my-image.svg";
const data = await fetch(imgURL);
const blob = await data.blob();
await navigator.clipboard.write([
new ClipboardItem({
[blob.type]: blob,
}),
]);
console.log("Fetched image copied to clipboard.");
} else {
console.log("SVG image not supported by clipboard");
}
} catch (err) {
console.error(err.name, err.message);
}
}
Specifications
Specification |
---|
Clipboard API and events # dom-clipboarditem-supports |
Browser compatibility
BCD tables only load in the browser