--- 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 Electron Platform** β€” build desktop apps for macOS, Windows, and Linux. Free & open source. ](/blog/announcing-the-capacitor-electron-platform/) * [ SDKs ](/docs/sdks/) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ Platform Behavior ](#platform-behavior) * [ Migrating from @capacitor/clipboard ](#migrating-from-capacitorclipboard) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ Cloudinary ](/docs/sdks/capacitor/cloudinary/) * [ Compass ](/docs/sdks/capacitor/compass/) * [ Contacts ](/docs/sdks/capacitor/contacts/) * [ Crisp ](/docs/sdks/capacitor/crisp/) * [ Datetime Picker ](/docs/sdks/capacitor/datetime-picker/) * [ Device Info ](/docs/sdks/capacitor/device-info/) * [ Dialog ](/docs/sdks/capacitor/dialog/) * [ Electron ](/docs/sdks/capacitor/electron/) * [ Exif ](/docs/sdks/capacitor/exif/) * [ 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/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Intercom ](/docs/sdks/capacitor/intercom/) * [ Intune ](/docs/sdks/capacitor/intune/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ 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/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ 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/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Tauri ](/docs/sdks/capacitor/tauri/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ 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/) * [ YouTube Player ](/docs/sdks/capacitor/youtube-player/) * [ 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) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Clipboard Plugin[ΒΆ](#capacitor-clipboard-plugin "Permanent link") Capacitor plugin to read from and write to the system clipboard. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](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! ## Use Cases[ΒΆ](#use-cases "Permanent link") The Clipboard plugin is typically used whenever an app lets users copy or paste content, for example: * **Copy to clipboard buttons**: Let users copy coupon codes, invite links, or wallet addresses with one tap. * **Paste support**: Read text, URLs, or images from the clipboard into your app, for example into a form or editor. * **Sharing images**: Copy a generated image (such as a QR code or chart) so users can paste it into other apps. * **Rich text workflows**: Copy formatted HTML content with a plain-text fallback for apps that cannot handle HTML. ## 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") The following examples show how to write text, HTML, images, and URLs to the clipboard, and how to read its current content. ### Write text to the clipboard[ΒΆ](#write-text-to-the-clipboard "Permanent link") Copy plain text to the system clipboard: `[](#%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)}; ` ### Write HTML with a plain-text fallback[ΒΆ](#write-html-with-a-plain-text-fallback "Permanent link") Copy HTML content and combine it with `text` to provide a plain-text fallback for apps that cannot handle HTML content: `[](#%5F%5Fcodelineno-4-1)import { Clipboard } from '@capawesome/capacitor-clipboard'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const writeHtml = async () => { [](#%5F%5Fcodelineno-4-4) await Clipboard.write({ [](#%5F%5Fcodelineno-4-5) html: 'Hello World', [](#%5F%5Fcodelineno-4-6) text: 'Hello World', [](#%5F%5Fcodelineno-4-7) }); [](#%5F%5Fcodelineno-4-8)}; ` ### Write an image to the clipboard[ΒΆ](#write-an-image-to-the-clipboard "Permanent link") Copy a real image (not just a data URL as plain text) by passing a Base64-encoded data URL: `[](#%5F%5Fcodelineno-5-1)import { Clipboard } from '@capawesome/capacitor-clipboard'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const writeImage = async () => { [](#%5F%5Fcodelineno-5-4) await Clipboard.write({ [](#%5F%5Fcodelineno-5-5) image: 'data:image/png;base64,iVBORw0KGgo...', [](#%5F%5Fcodelineno-5-6) }); [](#%5F%5Fcodelineno-5-7)}; ` ### Write a URL to the clipboard[ΒΆ](#write-a-url-to-the-clipboard "Permanent link") Copy a URL as a native URL clipboard item: `[](#%5F%5Fcodelineno-6-1)import { Clipboard } from '@capawesome/capacitor-clipboard'; [](#%5F%5Fcodelineno-6-2) [](#%5F%5Fcodelineno-6-3)const writeUrl = async () => { [](#%5F%5Fcodelineno-6-4) await Clipboard.write({ url: 'https://capawesome.io' }); [](#%5F%5Fcodelineno-6-5)}; ` ### Read the clipboard content[ΒΆ](#read-the-clipboard-content "Permanent link") Read the current content of the system clipboard. The result contains the content type (text, HTML, image, or URL) and the value. Note that on Android, reading the clipboard is only possible while the app is in the foreground, and on iOS, a system paste notification is displayed: `[](#%5F%5Fcodelineno-7-1)import { Clipboard } from '@capawesome/capacitor-clipboard'; [](#%5F%5Fcodelineno-7-2) [](#%5F%5Fcodelineno-7-3)const read = async () => { [](#%5F%5Fcodelineno-7-4) const { type, value } = await Clipboard.read(); [](#%5F%5Fcodelineno-7-5) console.log('Type:', type, 'Value:', value); [](#%5F%5Fcodelineno-7-6)}; ` ## API[ΒΆ](#api "Permanent link") * [read()](#read) * [write(...)](#write) * [Interfaces](#interfaces) * [Enums](#enums) ### read()[ΒΆ](#read "Permanent link") `[](#%5F%5Fcodelineno-8-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-9-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' } | ## FAQ[ΒΆ](#faq "Permanent link") ### How is this plugin different from other similar plugins?[ΒΆ](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link") It supports far more than plain text β€” copy and paste images, HTML with a plain-text fallback, and native URL items, with reliable real image handling on Android, iOS, and the web. The API is fully typed and actively maintained against the latest OS and framework versions, and it uses only official platform APIs so it stays safe for App Store and Google Play submissions. If you only ever copy plain text, a simpler setup is perfectly fine; if you need rich content and consistent behavior across every platform, this plugin is designed for exactly that. ### Why is a notification shown when my app reads the clipboard?[ΒΆ](#why-is-a-notification-shown-when-my-app-reads-the-clipboard "Permanent link") On iOS 14 and later, the system shows a paste notification banner every time the clipboard is read. On Android 12 (API level 31) and later, the system shows a toast message when an app reads clipboard content that was written by another app. Both are expected platform behavior and cannot be suppressed. ### Why does reading the clipboard fail on Android?[ΒΆ](#why-does-reading-the-clipboard-fail-on-android "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, so make sure to only call it in response to a user interaction while the app is visible. ### Can I write multiple content types at once?[ΒΆ](#can-i-write-multiple-content-types-at-once "Permanent link") No, exactly one of `text`, `html`, `image` or `url` must be provided when calling `write(...)`. The only exception is that `html` may additionally be combined with `text` to provide a plain-text fallback for apps that cannot handle HTML content. ### How are images handled by this plugin?[ΒΆ](#how-are-images-handled-by-this-plugin "Permanent link") Images are written to the clipboard as real images, not just data URLs as plain text, by passing a Base64-encoded data URL to `write(...)`. When reading, images are also returned as a Base64-encoded data URL. See the [usage examples](#write-an-image-to-the-clipboard) above. ### How is this plugin different from the official `@capacitor/clipboard` plugin?[ΒΆ](#how-is-this-plugin-different-from-the-official-capacitorclipboard-plugin "Permanent link") This plugin is a drop-in alternative to the official `@capacitor/clipboard` plugin with real image support on Android and HTML support on all platforms. Only a few method options differ, see the [migration table](#migrating-from-capacitorclipboard) above. ### Can I use this plugin with Ionic, React, Vue or Angular?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link") Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects. ## Related Plugins[ΒΆ](#related-plugins "Permanent link") * [Share Target](https://capawesome.io/docs/sdks/capacitor/share-target/): Receive content such as text, links, and files from other apps. * [Text Interaction](https://capawesome.io/docs/sdks/capacitor/text-interaction/): Enable and disable text interaction (selection, magnifier, callout menu) in the app's WebView. ## 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/). ## 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 8, 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"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "It supports far more than plain text β€” copy and paste images, HTML with a plain-text fallback, and native URL items, with reliable real image handling on Android, iOS, and the web. The API is fully typed and actively maintained against the latest OS and framework versions, and it uses only official platform APIs so it stays safe for App Store and Google Play submissions. If you only ever copy plain text, a simpler setup is perfectly fine; if you need rich content and consistent behavior across every platform, this plugin is designed for exactly that."}}, {"@type": "Question", "name": "Why is a notification shown when my app reads the clipboard?", "acceptedAnswer": {"@type": "Answer", "text": "On iOS 14 and later, the system shows a paste notification banner every time the clipboard is read. On Android 12 (API level 31) and later, the system shows a toast message when an app reads clipboard content that was written by another app. Both are expected platform behavior and cannot be suppressed."}}, {"@type": "Question", "name": "Why does reading the clipboard fail on Android?", "acceptedAnswer": {"@type": "Answer", "text": "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, so make sure to only call it in response to a user interaction while the app is visible."}}, {"@type": "Question", "name": "Can I write multiple content types at once?", "acceptedAnswer": {"@type": "Answer", "text": "No, exactly one of text, html, image or url must be provided when calling write(...). The only exception is that html may additionally be combined with text to provide a plain-text fallback for apps that cannot handle HTML content."}}, {"@type": "Question", "name": "How are images handled by this plugin?", "acceptedAnswer": {"@type": "Answer", "text": "Images are written to the clipboard as real images, not just data URLs as plain text, by passing a Base64-encoded data URL to write(...). When reading, images are also returned as a Base64-encoded data URL. See the usage examples above."}}, {"@type": "Question", "name": "How is this plugin different from the official @capacitor/clipboard plugin?", "acceptedAnswer": {"@type": "Answer", "text": "This plugin is a drop-in alternative to the official @capacitor/clipboard plugin with real image support on Android and HTML support on all platforms. Only a few method options differ, see the migration table above."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/clipboard/"} ```