最新の手法
Async Clipboard API を使用する
ユーザーのクリップボードからプログラムで画像を読み取るには(つまり、ボタンがクリックされた後)、Async Clipboard API の read()
メソッドを使用します。クリップボードからの読み取り権限がまだ付与されていない場合は、navigator.clipboard.read()
の呼び出しで、このメソッドの最初の呼び出し時にその権限がリクエストされます。
const pasteButton = document.querySelector('#paste-button');
pasteButton.addEventListener('click', async () => {
try {
const clipboardItems = await navigator.clipboard.read();
for (const clipboardItem of clipboardItems) {
const imageTypes = clipboardItem.types.find(type => type.startsWith('image/'))
for (const imageType of imageTypes) {
const blob = await clipboardItem.getType(imageType);
// Do something with the image blob.
}
}
} catch (err) {
console.error(err.name, err.message);
}
});
従来のやり方
paste
イベントをリッスンする
画像を貼り付ける従来の方法は、(同期)Clipboard API を使用することです。この API を使用すると、Document: paste
イベント内の clipboardData
フィールドにアクセスできます。ただし、この方法には制限があります。たとえば、同期であるため、大量のデータを貼り付けるとページがブロックされる可能性があります。
document.addEventListener('paste', async (e) => {
e.preventDefault();
for (const clipboardItem of e.clipboardData.files) {
if (clipboardItem.type.startsWith('image/')) {
// Do something with the image file.
}
}
});
段階的な補正
Async Clipboard API をサポートしていないブラウザの場合、プログラム(ボタンのクリックなど)でユーザーのクリップボードにアクセスすることはできません。したがって、paste
イベントでユーザーのクリップボードにアクセスするには、Async Clipboard API を使用して、(同期)Clipboard API にフォールバックできます。
navigator.clipboard.read
由来の ClipboardItem
オブジェクトには配列の types
フィールドがあり、event.clipboardData.files
由来の File
オブジェクトには文字列である type
フィールドがあります。クリップボード内の画像について、type
フィールドまたは types
の各フィールドを条件付きでチェックできます。
document.addEventListener('paste', async (e) => {
e.preventDefault();
const clipboardItems = typeof navigator?.clipboard?.read === 'function' ? await navigator.clipboard.read() : e.clipboardData.files;
for (const clipboardItem of clipboardItems) {
let blob;
if (clipboardItem.type?.startsWith('image/')) {
// For files from `e.clipboardData.files`.
blob = clipboardItem
// Do something with the blob.
} else {
// For files from `navigator.clipboard.read()`.
const imageTypes = clipboardItem.types?.filter(type => type.startsWith('image/'))
for (const imageType of imageTypes) {
blob = await clipboardItem.getType(imageType);
// Do something with the blob.
}
}
}
});
参考資料
- MDN の Clipboard API
- web.dev でのクリップボード アクセスのブロックを解除する
デモ
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link
rel="icon"
href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>🎉</text></svg>"
/>
<title>How to paste images</title>
</head>
<body>
<h1>How to paste images</h1>
<p>Hit <kbd>⌘</kbd> + <kbd>v</kbd> (for macOS) or <kbd>ctrl</kbd> + <kbd>v</kbd>
(for other operating systems) to paste images anywhere in this page.
</p>
</body>
</html>
CSS
:root {
color-scheme: dark light;
}
html {
box-sizing: border-box;
}
*,
*:before,
*:after {
box-sizing: inherit;
}
body {
margin: 1rem;
font-family: system-ui, sans-serif;
}
button {
display: block;
}
JS
document.addEventListener('paste', async (e) => {
e.preventDefault();
const clipboardItems = typeof navigator?.clipboard?.read === 'function' ? await navigator.clipboard.read() : e.clipboardData.files;
for (const clipboardItem of clipboardItems) {
let blob;
if (clipboardItem.type?.startsWith('image/')) {
// For files from `e.clipboardData.files`.
blob = clipboardItem
// Do something with the blob.
appendImage(blob);
} else {
// For files from `navigator.clipboard.read()`.
const imageTypes = clipboardItem.types?.filter(type => type.startsWith('image/'))
for (const imageType of imageTypes) {
blob = await clipboardItem.getType(imageType);
// Do something with the blob.
appendImage(blob);
}
}
}
});
const appendImage = (blob) => {
const img = document.createElement('img');
img.src = URL.createObjectURL(blob);
document.body.append(img);
};