@capacitor/clipboard
The Clipboard API enables copy and pasting to/from the system clipboard.
API
write(...)
write(options: ClipboardWriteOptions) => Promise<void>
Write a value to the clipboard (the "copy" action)
Returns: Promise<void>
Since: 1.0.0
read()
read() => Promise<ClipboardReadResult>
Read a value from the clipboard (the "paste" action)
Returns: Promise<ClipboardReadResult>
Since: 1.0.0
Interfaces
ClipboardWriteOptions
Represents the data to be written to the clipboard.
Prop | Type | Description | Since |
---|
string | string | Text value to copy. | 1.0.0 |
image | string | Image in Data URL format to copy. | 1.0.0 |
url | string | URL string to copy. | 1.0.0 |
label | string | User visible label to accompany the copied data (Android Only). | 1.0.0 |
ClipboardReadResult
Represents the data read from the clipboard.
Prop | Type | Description | Since |
---|
value | string | Data read from the clipboard. | 1.0.0 |
type | string | Type of data in the clipboard. | 1.0.0 |