@capacitor/clipboard

Clipboard API は、システムクリップボードとの間でコピーアンドペーストを可能にします。

インストール

npm install @capacitor/clipboard
npx cap sync

例

import { Clipboard } from '@capacitor/clipboard';

const writeToClipboard = async () => {
  await Clipboard.write({
    string: "Hello World!"
  });
};

const checkClipboard = async () => {
  const { type, value } = await Clipboard.read();

  console.log(`Got ${type} from clipboard: ${value}`);
};

API

• write(...)
• read()
• インターフェース

write(...)

write(options: WriteOptions) => Promise<void>

値をクリップボードに書き込みます（「コピー」アクション）。

パラメータ	型
options	WriteOptions

リリース 1.0.0

---

read()

read() => Promise<ReadResult>

クリップボードから値を読み取ります（「ペースト」アクション）。

戻り値: Promise<ReadResult>

リリース 1.0.0

---

インターフェース

WriteOptions

クリップボードに書き込むデータを表します。

プロパティ	型	説明	リリース
string	string	コピーするテキスト値。	1.0.0
image	string	コピーする Data URL 形式の画像。	1.0.0
url	string	コピーする URL 文字列。	1.0.0
label	string	コピーされたデータに付随する、ユーザーに表示されるラベル (Android のみ)。	1.0.0

ReadResult

クリップボードから読み取られたデータを表します。

プロパティ	型	説明	リリース
value	string	クリップボードから読み取られたデータ。	1.0.0
type	string	クリップボード内のデータの型。	1.0.0