@capacitor/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