---
description: Capacitor plugin to read from and write to the system clipboard with support for text, HTML, images, and URLs on Android, iOS, and the web.
title: Capacitor Clipboard Plugin - Capawesome
image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/clipboard.png
---
[Skip to content ](#capacitor-clipboard-plugin)
[🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/)
* [ SDKs ](/docs/sdks/)
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Platform Behavior ](#platform-behavior)
* [ Migrating from @capacitor/clipboard ](#migrating-from-capacitorclipboard)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ Cloudinary ](/docs/sdks/capacitor/cloudinary/)
* [ Compass ](/docs/sdks/capacitor/compass/)
* [ Contacts ](/docs/sdks/capacitor/contacts/)
* [ Datetime Picker ](/docs/sdks/capacitor/datetime-picker/)
* [ Device Info ](/docs/sdks/capacitor/device-info/)
* [ Dialog ](/docs/sdks/capacitor/dialog/)
* [ Facebook Sign-In ](/docs/sdks/capacitor/facebook-sign-in/)
* [ File Compressor ](/docs/sdks/capacitor/file-compressor/)
* [ File Opener ](/docs/sdks/capacitor/file-opener/)
* [ File Picker ](/docs/sdks/capacitor/file-picker/)
* [ Firebase ](/docs/sdks/capacitor/firebase/)
* [ Formbricks ](/docs/sdks/capacitor/formbricks/)
* [ Geocoder ](/docs/sdks/capacitor/geocoder/)
* [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/)
* [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/)
* [ Gyroscope ](/docs/sdks/capacitor/gyroscope/)
* [ Haptics ](/docs/sdks/capacitor/haptics/)
* [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/)
* [ Install Referrer ](/docs/sdks/capacitor/install-referrer/)
* [ Keep Awake ](/docs/sdks/capacitor/keep-awake/)
* [ libSQL ](/docs/sdks/capacitor/libsql/)
* [ Live Update ](/docs/sdks/capacitor/live-update/)
* [ Localization ](/docs/sdks/capacitor/localization/)
* [ Mail Composer ](/docs/sdks/capacitor/mail-composer/)
* [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/)
* [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/)
* [ Media Session ](/docs/sdks/capacitor/media-session/)
* [ ML Kit ](/docs/sdks/capacitor/mlkit/)
* [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/)
* [ Network ](/docs/sdks/capacitor/network/)
* [ NFC ](/docs/sdks/capacitor/nfc/)
* [ Node.js ](/docs/sdks/capacitor/nodejs/)
* [ OAuth ](/docs/sdks/capacitor/oauth/)
* [ Passkeys ](/docs/sdks/capacitor/passkeys/)
* [ Password Autofill ](/docs/sdks/capacitor/password-autofill/)
* [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/)
* [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/)
* [ Pedometer ](/docs/sdks/capacitor/pedometer/)
* [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/)
* [ Photo Editor ](/docs/sdks/capacitor/photo-editor/)
* [ PixLive ](/docs/sdks/capacitor/pixlive/)
* [ PostHog ](/docs/sdks/capacitor/posthog/)
* [ Printer ](/docs/sdks/capacitor/printer/)
* [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/)
* [ Purchases ](/docs/sdks/capacitor/purchases/)
* [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/)
* [ Root Detection ](/docs/sdks/capacitor/root-detection/)
* [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/)
* [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/)
* [ Screen Reader ](/docs/sdks/capacitor/screen-reader/)
* [ Screenshot ](/docs/sdks/capacitor/screenshot/)
* [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/)
* [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/)
* [ Shake ](/docs/sdks/capacitor/shake/)
* [ Silent Mode ](/docs/sdks/capacitor/silent-mode/)
* [ SIM ](/docs/sdks/capacitor/sim/)
* [ SMS Composer ](/docs/sdks/capacitor/sms-composer/)
* [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/)
* [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/)
* [ Share Target ](/docs/sdks/capacitor/share-target/)
* [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/)
* [ SQLite ](/docs/sdks/capacitor/sqlite/)
* [ Superwall ](/docs/sdks/capacitor/superwall/)
* [ Text Zoom ](/docs/sdks/capacitor/text-zoom/)
* [ Thermal State ](/docs/sdks/capacitor/thermal-state/)
* [ Toast ](/docs/sdks/capacitor/toast/)
* [ Torch ](/docs/sdks/capacitor/torch/)
* [ Vault ](/docs/sdks/capacitor/vault/)
* [ Volume ](/docs/sdks/capacitor/volume/)
* [ Wallet ](/docs/sdks/capacitor/wallet/)
* [ Wifi ](/docs/sdks/capacitor/wifi/)
* [ Zip ](/docs/sdks/capacitor/zip/)
* [ Cordova ](/docs/sdks/cordova/)
* [ Cloud ](/docs/cloud/)
* [ Integrations ](/docs/cloud/live-updates/integrations/)
* Concepts
* Reference
* [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/)
* [ FAQ ](/docs/cloud/live-updates/faq/)
* [ Native Builds ](/docs/cloud/native-builds/)
* [ Set Up Environments ](/docs/cloud/native-builds/environments/)
* [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/)
* [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/)
* [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/)
* [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/)
* [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/)
* [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/)
* [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/)
* [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/)
* [ Build without Git ](/docs/cloud/native-builds/build-without-git/)
* [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/)
* [ Integrations ](/docs/cloud/native-builds/integrations/)
* Reference
* [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [ FAQ ](/docs/cloud/native-builds/faq/)
* [ App Store Publishing ](/docs/cloud/app-store-publishing/)
* [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/)
* [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/)
* [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/)
* [ FAQ ](/docs/cloud/app-store-publishing/faq/)
* [ Automations ](/docs/cloud/automations/)
* [ Reference ](/docs/cloud/automations/reference/)
* [ Troubleshooting ](/docs/cloud/automations/troubleshooting/)
* [ FAQ ](/docs/cloud/automations/faq/)
* [ Assist ](/docs/cloud/assist/)
* [ CLI ](/docs/cloud/cli/)
* APIs and SDKs
* [ Webhooks ](/docs/cloud/webhooks/)
* [ Integrations ](/docs/cloud/integrations/)
* Account
* [ Organization ](/docs/cloud/organizations/)
* [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/)
* [ Audit Logs ](/docs/cloud/organizations/audit-logs/)
* [ Billing ](/docs/cloud/organizations/billing/)
* [ License Keys ](/docs/cloud/license-keys/)
* [ AI ](/docs/ai/)
* [ Insiders ](/docs/insiders/)
* [ Billing & Plans ](/docs/insiders/billing-and-plans/)
* [ FAQ ](/docs/insiders/faq/)
* [ License ](https://capawesome.io/legal/eula/)
* [ Support ](/docs/support/)
* [ Contributing ](/docs/contributing/)
* Contributing code
* [ Code of Conduct ](/docs/contributing/code-of-conduct/)
* [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion)
* [ Blog ](/blog/)
* Categories
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Platform Behavior ](#platform-behavior)
* [ Migrating from @capacitor/clipboard ](#migrating-from-capacitorclipboard)
* [ Changelog ](#changelog)
* [ License ](#license)
# Capacitor Clipboard Plugin[¶](#capacitor-clipboard-plugin "Permanent link")
Capacitor plugin to read from and write to the system clipboard.
[  ](https://cloud.capawesome.io/)
## Features[¶](#features "Permanent link")
* 📋 **Read & Write**: Read from and write to the system clipboard.
* 🖼️ **Images**: Copy and paste real images, not just data URLs as plain text.
* 📝 **Rich Text**: Write HTML content with a plain-text fallback.
* 🔗 **URLs**: Copy URLs as native URL clipboard items.
* 🌐 **Cross-platform**: Works on Android, iOS, and the web.
* 🔒 **App Store safe**: Uses only official platform APIs.
* 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.
* 🔁 **Up-to-date**: Always supports the latest Capacitor version.
Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
## Newsletter[¶](#newsletter "Permanent link")
Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
## Compatibility[¶](#compatibility "Permanent link")
| Plugin Version | Capacitor Version | Status |
| -------------- | ----------------- | -------------- |
| 0.x.x | \>=8.x.x | Active support |
## Installation[¶](#installation "Permanent link")
You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:
`[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins
`
Then use the following prompt:
`` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-clipboard` plugin in my project.
``
If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:
`[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-clipboard
[](#%5F%5Fcodelineno-2-2)npx cap sync
`
### Android[¶](#android "Permanent link")
No additional configuration is required for this plugin.
### iOS[¶](#ios "Permanent link")
No additional configuration is required for this plugin.
## Configuration[¶](#configuration "Permanent link")
No configuration required for this plugin.
## Usage[¶](#usage "Permanent link")
`[](#%5F%5Fcodelineno-3-1)import { Clipboard } from '@capawesome/capacitor-clipboard';
[](#%5F%5Fcodelineno-3-2)
[](#%5F%5Fcodelineno-3-3)const writeText = async () => {
[](#%5F%5Fcodelineno-3-4) await Clipboard.write({ text: 'Hello World' });
[](#%5F%5Fcodelineno-3-5)};
[](#%5F%5Fcodelineno-3-6)
[](#%5F%5Fcodelineno-3-7)const writeHtml = async () => {
[](#%5F%5Fcodelineno-3-8) await Clipboard.write({
[](#%5F%5Fcodelineno-3-9) html: 'Hello World',
[](#%5F%5Fcodelineno-3-10) text: 'Hello World',
[](#%5F%5Fcodelineno-3-11) });
[](#%5F%5Fcodelineno-3-12)};
[](#%5F%5Fcodelineno-3-13)
[](#%5F%5Fcodelineno-3-14)const writeImage = async () => {
[](#%5F%5Fcodelineno-3-15) await Clipboard.write({
[](#%5F%5Fcodelineno-3-16) image: 'data:image/png;base64,iVBORw0KGgo...',
[](#%5F%5Fcodelineno-3-17) });
[](#%5F%5Fcodelineno-3-18)};
[](#%5F%5Fcodelineno-3-19)
[](#%5F%5Fcodelineno-3-20)const writeUrl = async () => {
[](#%5F%5Fcodelineno-3-21) await Clipboard.write({ url: 'https://capawesome.io' });
[](#%5F%5Fcodelineno-3-22)};
[](#%5F%5Fcodelineno-3-23)
[](#%5F%5Fcodelineno-3-24)const read = async () => {
[](#%5F%5Fcodelineno-3-25) const { type, value } = await Clipboard.read();
[](#%5F%5Fcodelineno-3-26) console.log('Type:', type, 'Value:', value);
[](#%5F%5Fcodelineno-3-27)};
`
## API[¶](#api "Permanent link")
* [read()](#read)
* [write(...)](#write)
* [Interfaces](#interfaces)
* [Enums](#enums)
### read()[¶](#read "Permanent link")
`[](#%5F%5Fcodelineno-4-1)read() => Promise
`
Read the current content of the system clipboard.
On Android, reading the clipboard is only possible while the app is in the foreground.
On iOS, reading the clipboard displays a system paste notification. This is expected behavior and cannot be suppressed.
**Returns:** `Promise<[ReadResult](#readresult)>`
**Since:** 0.1.0
---
### write(...)[¶](#write "Permanent link")
`[](#%5F%5Fcodelineno-5-1)write(options: WriteOptions) => Promise
`
Write content to the system clipboard.
Exactly one of `text`, `html`, `image` or `url` must be provided. The `html` property may additionally be combined with `text` to provide a plain-text fallback.
| Param | Type |
| ----------- | ----------------------------- |
| **options** | [WriteOptions](#writeoptions) |
**Since:** 0.1.0
---
### Interfaces[¶](#interfaces "Permanent link")
#### ReadResult[¶](#readresult "Permanent link")
| Prop | Type | Description | Since |
| --------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----- |
| **type** | [ClipboardContentType](#clipboardcontenttype) | The type of the content that was read from the clipboard. | 0.1.0 |
| **value** | string | The content that was read from the clipboard. Images are returned as a Base64-encoded data URL. | 0.1.0 |
#### WriteOptions[¶](#writeoptions "Permanent link")
| Prop | Type | Description | Since |
| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **html** | string | The HTML content to write to the clipboard. Combine this with text to provide a plain-text fallback for apps that cannot handle HTML content. | 0.1.0 |
| **image** | string | The image to write to the clipboard as a Base64-encoded data URL. | 0.1.0 |
| **label** | string | The label used to describe the clipboard content. Only available on Android. | 0.1.0 |
| **text** | string | The plain text to write to the clipboard. | 0.1.0 |
| **url** | string | The URL to write to the clipboard. | 0.1.0 |
### Enums[¶](#enums "Permanent link")
#### ClipboardContentType[¶](#clipboardcontenttype "Permanent link")
| Members | Value | Description | Since |
| --------- | ------- | --------------------------------------------------------------- | ----- |
| **Html** | 'HTML' | The content is HTML. | 0.1.0 |
| **Image** | 'IMAGE' | The content is an image, returned as a Base64-encoded data URL. | 0.1.0 |
| **Text** | 'TEXT' | The content is plain text. | 0.1.0 |
| **Url** | 'URL' | The content is a URL. | 0.1.0 |
## Platform Behavior[¶](#platform-behavior "Permanent link")
### Android[¶](#android%5F1 "Permanent link")
* On Android 10 (API level 29) and later, apps can only read the clipboard while they are in the foreground and have input focus. The `read(...)` method rejects otherwise.
* On Android 12 (API level 31) and later, the system shows a toast message when an app reads the clipboard content that was written by another app. This is expected behavior and cannot be suppressed.
### iOS[¶](#ios%5F1 "Permanent link")
* On iOS 14 and later, the system shows a paste notification banner every time the clipboard is read. This is expected behavior and cannot be suppressed.
## Migrating from `@capacitor/clipboard`[¶](#migrating-from-capacitorclipboard "Permanent link")
This plugin is a drop-in alternative to the official [@capacitor/clipboard](https://github.com/ionic-team/capacitor-plugins/tree/main/clipboard) plugin with real image support on Android and HTML support on all platforms. The following differences apply:
| @capacitor/clipboard | @capawesome/capacitor-clipboard |
| ------------------------------------------------ | ------------------------------------------------------- |
| write({ string: 'Hello' }) | write({ text: 'Hello' }) |
| write({ image: dataUrl }) (text-only on Android) | write({ image: dataUrl }) (real image on all platforms) |
| — | write({ html: 'Hello', text: 'Hello' }) |
| read() → { value, type: 'text/plain' } | read() → { value, type: 'TEXT' } |
## Changelog[¶](#changelog "Permanent link")
See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/clipboard/CHANGELOG.md).
## License[¶](#license "Permanent link")
See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/clipboard/LICENSE).
July 7, 2026
Back to top
```json
{"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/clipboard/#article", "headline": "Capacitor Clipboard Plugin", "name": "Capacitor Clipboard Plugin", "description": "Capacitor plugin to read from and write to the system clipboard with support for text, HTML, images, and URLs on Android, iOS, and the web.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/clipboard/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/clipboard/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/clipboard/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/clipboard/#software", "name": "Capacitor Clipboard Plugin", "description": "Capacitor plugin to read from and write to the system clipboard with support for text, HTML, images, and URLs on Android, iOS, and the web.", "url": "https://capawesome.io/docs/sdks/capacitor/clipboard/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]}
```