メインコンテンツまでスキップ
Version: v4

@capacitor/clipboard

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

Install

npm install @capacitor/clipboard
npx cap sync

Example

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(...)

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

Write a value to the clipboard (the "copy" action)

ParamType
optionsWriteOptions

Since: 1.0.0


read()

read() => Promise<ReadResult>

Read a value from the clipboard (the "paste" action)

Returns: Promise<ReadResult>

Since: 1.0.0


Interfaces

WriteOptions

Represents the data to be written to the clipboard.

PropTypeDescriptionSince
stringstringText value to copy.1.0.0
imagestringImage in Data URL format to copy.1.0.0
urlstringURL string to copy.1.0.0
labelstringUser visible label to accompany the copied data (Android Only).1.0.0

ReadResult

Represents the data read from the clipboard.

PropTypeDescriptionSince
valuestringData read from the clipboard.1.0.0
typestringType of data in the clipboard.1.0.0