{"_id":"@capawesome/capacitor-clipboard","_rev":"4-5891f3fecfacdb75e678d3faa9e1df87","name":"@capawesome/capacitor-clipboard","dist-tags":{"latest":"0.1.2"},"versions":{"0.0.1":{"name":"@capawesome/capacitor-clipboard","version":"0.0.1","keywords":["capacitor","plugin","native","clipboard","copy","paste"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@capawesome/capacitor-clipboard@0.0.1","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/clipboard/","bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"dist":{"shasum":"2d34c01f58deeda65f078d4ed8f685354440abd4","tarball":"https://registry.npmjs.org/@capawesome/capacitor-clipboard/-/capacitor-clipboard-0.0.1.tgz","fileCount":41,"integrity":"sha512-yOIiE1GdHuEKZA09OBvGSQLRrYAhcfc4kR86Or10a5ri33bpeT6X98L07JHEYWelOZp+KIcgnH8OuFDPeHWCuA==","signatures":[{"sig":"MEUCIBdH1zff+wBJ0s/a5cFXgk2lBPA44qk14L1xGZ8ZAl0yAiEAx9/mRXlut8p3gSW0LQMxf3T9GRa4rES/uo1tXZAvPdI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":103558},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"e18228f8362b044cd453aba542fe8e0a02fd996f","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ClipboardPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"robingenz","email":"mail@robingenz.dev"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"url":"git+https://github.com/capawesome-team/capacitor-plugins.git","type":"git"},"_npmVersion":"11.13.0","description":"Capacitor plugin to read from and write to the system clipboard.","directories":{},"_nodeVersion":"24.16.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-clipboard_0.0.1_1783426810362_0.3015070087298204","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@capawesome/capacitor-clipboard","version":"0.1.0","keywords":["capacitor","plugin","native","clipboard","copy","paste","capacitor-plugin","copy to clipboard","clipboard image","clipboard html","rich text","pasteboard","copy paste"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@capawesome/capacitor-clipboard@0.1.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/clipboard/","bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"dist":{"shasum":"ea9e4f4758fb5cce94185a127b371675a9188693","tarball":"https://registry.npmjs.org/@capawesome/capacitor-clipboard/-/capacitor-clipboard-0.1.0.tgz","fileCount":41,"integrity":"sha512-NeGhNtZVp0mDLOJ2jRcYa4dC78EXNUzmuIHIt55K2+u11UHr7GVxpJeIGyodIpnyVA5wD1xq3PjwIm25LamRAg==","signatures":[{"sig":"MEUCIQDt8LAcTO+KWj3YLwYC52dkCn8DTbOj9+KirQzl5X/uTgIgT6ri5TSAdheuHni3/uHgJ1U6CfM4A6WKRUBX3Q8quyQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capawesome%2fcapacitor-clipboard@0.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":108364},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"1ce17b1fd14c43b2f1d5d3c2da82221e1d1dca37","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ClipboardPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:b45b3cc2-637a-40dd-883e-2eecacdee2e7"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"url":"git+https://github.com/capawesome-team/capacitor-plugins.git","type":"git"},"_npmVersion":"11.16.0","description":"Capacitor plugin to read from and write to the system clipboard on Android, iOS, and Web.","directories":{},"_nodeVersion":"24.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-clipboard_0.1.0_1784015515539_0.5217556606751599","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@capawesome/capacitor-clipboard","version":"0.1.1","keywords":["capacitor","plugin","native","clipboard","copy","paste","capacitor-plugin","copy to clipboard","clipboard image","clipboard html","rich text","pasteboard","copy paste"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@capawesome/capacitor-clipboard@0.1.1","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/clipboard/","bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"dist":{"shasum":"c50f597b8bbe30e0a72913ac62e4a61eb662cebc","tarball":"https://registry.npmjs.org/@capawesome/capacitor-clipboard/-/capacitor-clipboard-0.1.1.tgz","fileCount":41,"integrity":"sha512-F+fa4hAEVijtgY9z0By0K85+6Flgf+l939TbhskJp9ITIVvBAM1SYZmRKU3x7EGXrv98X+6b/iFFOWfAlo1FIQ==","signatures":[{"sig":"MEUCIHGSEeRnpOP70VV73mGIfv+CAMN/Aolcv21fNVsQaviKAiEA1ZSusX9LQVv3bvj/WG4uEi6+UOG+YfgO2UyWvG9Qkoc=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capawesome%2fcapacitor-clipboard@0.1.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":108373},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"3e61f4b412f9f3f512c21169bb135bbb23a67e6d","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ClipboardPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:b45b3cc2-637a-40dd-883e-2eecacdee2e7"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"url":"git+https://github.com/capawesome-team/capacitor-plugins.git","type":"git"},"_npmVersion":"11.16.0","description":"Capacitor plugin to read from and write to the system clipboard on Android, iOS, and Web.","directories":{},"_nodeVersion":"24.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-clipboard_0.1.1_1784102971551_0.42960508471351777","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@capawesome/capacitor-clipboard","version":"0.1.2","description":"Capacitor plugin to read from and write to the system clipboard on Android, iOS, and Web.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-plugins.git"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"funding":[{"type":"github","url":"https://github.com/sponsors/capawesome-team/"},{"type":"opencollective","url":"https://opencollective.com/capawesome"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/clipboard/","keywords":["capacitor","plugin","native","clipboard","copy","paste","capacitor-plugin","copy to clipboard","clipboard image","clipboard html","rich text","pasteboard","copy paste"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api ClipboardPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd ..","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"8.0.0","@capacitor/cli":"8.4.2","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/ios":"8.0.0","@ionic/eslint-config":"0.4.0","eslint":"8.57.0","prettier-plugin-java":"2.9.7","rimraf":"6.1.2","rollup":"4.62.3","swiftlint":"2.0.0","typescript":"5.9.3"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"publishConfig":{"access":"public"},"gitHead":"7c1937ed10b7de86ca2c1cdc3539a2735fd69a00","_id":"@capawesome/capacitor-clipboard@0.1.2","_nodeVersion":"24.19.0","_npmVersion":"11.17.0","dist":{"integrity":"sha512-MJO7Yl7Xd21PpWbhR9Tbxz3JZ8MnCRWDr9/idchDjgUncm6QWajBze8FhVoEKmzlWoeXY7xNKEyXjHTsuRGwtg==","shasum":"228062ae0627cbdd247d581dd49185f6085d3363","tarball":"https://registry.npmjs.org/@capawesome/capacitor-clipboard/-/capacitor-clipboard-0.1.2.tgz","fileCount":41,"unpackedSize":108436,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capawesome%2fcapacitor-clipboard@0.1.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIC5QP9duBC1G5hlwnvOcMNV3F6jNmlt2LdhbV7mc63zoAiEA9ptUbownVSTY5iBXSn2k6GSL+2eg/zJHUQHZNdpiUY4="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:b45b3cc2-637a-40dd-883e-2eecacdee2e7"}},"directories":{},"maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/capacitor-clipboard_0.1.2_1788337317512_0.8001464462549641"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-07T12:20:10.140Z","modified":"2026-09-02T08:21:58.068Z","0.0.1":"2026-07-07T12:20:10.506Z","0.1.0":"2026-07-14T07:51:55.683Z","0.1.1":"2026-07-15T08:09:31.699Z","0.1.2":"2026-09-02T08:21:57.637Z"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","homepage":"https://capawesome.io/docs/sdks/capacitor/clipboard/","keywords":["capacitor","plugin","native","clipboard","copy","paste","capacitor-plugin","copy to clipboard","clipboard image","clipboard html","rich text","pasteboard","copy paste"],"repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-plugins.git"},"description":"Capacitor plugin to read from and write to the system clipboard on Android, iOS, and Web.","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"readme":"# Capacitor Clipboard Plugin\n\nCapacitor plugin to read from and write to the system clipboard.\n\n<div class=\"capawesome-z29o10a\">\n  <a href=\"https://cloud.capawesome.io/\" target=\"_blank\">\n    <img alt=\"Deliver Live Updates to your Capacitor app with Capawesome Cloud\" src=\"https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1\" />\n  </a>\n</div>\n\n## Features\n\n- 📋 **Read & Write**: Read from and write to the system clipboard.\n- 🖼️ **Images**: Copy and paste real images, not just data URLs as plain text.\n- 📝 **Rich Text**: Write HTML content with a plain-text fallback.\n- 🔗 **URLs**: Copy URLs as native URL clipboard items.\n- 🌐 **Cross-platform**: Works on Android, iOS, and the web.\n- 🔒 **App Store safe**: Uses only official platform APIs.\n- 🤝 **Compatibility**: Works alongside the [Share Target](https://capawesome.io/docs/sdks/capacitor/share-target/) and [Text Interaction](https://capawesome.io/docs/sdks/capacitor/text-interaction/) plugins.\n- 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.\n- 🔁 **Up-to-date**: Always supports the latest Capacitor version.\n\nMissing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!\n\n## Use Cases\n\nThe Clipboard plugin is typically used whenever an app lets users copy or paste content, for example:\n\n- **Copy to clipboard buttons**: Let users copy coupon codes, invite links, or wallet addresses with one tap.\n- **Paste support**: Read text, URLs, or images from the clipboard into your app, for example into a form or editor.\n- **Sharing images**: Copy a generated image (such as a QR code or chart) so users can paste it into other apps.\n- **Rich text workflows**: Copy formatted HTML content with a plain-text fallback for apps that cannot handle HTML.\n\n## Compatibility\n\n| Plugin Version | Capacitor Version | Status         |\n| -------------- | ----------------- | -------------- |\n| 0.x.x          | >=8.x.x           | Active support |\n\n## Installation\n\nYou can use our **AI-Assisted Setup** to install the plugin.\nAdd the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:\n\n```bash\nnpx skills add capawesome-team/skills --skill capacitor-plugins\n```\n\nThen use the following prompt:\n\n```\n Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-clipboard` plugin in my project.\n```\n\nIf you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:\n\n```bash\nnpm install @capawesome/capacitor-clipboard\nnpx cap sync\n```\n\n### Android\n\nNo additional configuration is required for this plugin.\n\n### iOS\n\nNo additional configuration is required for this plugin.\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## Usage\n\nThe following examples show how to write text, HTML, images, and URLs to the clipboard, and how to read its current content.\n\n### Write text to the clipboard\n\nCopy plain text to the system clipboard:\n\n```typescript\nimport { Clipboard } from '@capawesome/capacitor-clipboard';\n\nconst writeText = async () => {\n  await Clipboard.write({ text: 'Hello World' });\n};\n```\n\n### Write HTML with a plain-text fallback\n\nCopy HTML content and combine it with `text` to provide a plain-text fallback for apps that cannot handle HTML content:\n\n```typescript\nimport { Clipboard } from '@capawesome/capacitor-clipboard';\n\nconst writeHtml = async () => {\n  await Clipboard.write({\n    html: '<b>Hello World</b>',\n    text: 'Hello World',\n  });\n};\n```\n\n### Write an image to the clipboard\n\nCopy a real image (not just a data URL as plain text) by passing a Base64-encoded data URL:\n\n```typescript\nimport { Clipboard } from '@capawesome/capacitor-clipboard';\n\nconst writeImage = async () => {\n  await Clipboard.write({\n    image: 'data:image/png;base64,iVBORw0KGgo...',\n  });\n};\n```\n\n### Write a URL to the clipboard\n\nCopy a URL as a native URL clipboard item:\n\n```typescript\nimport { Clipboard } from '@capawesome/capacitor-clipboard';\n\nconst writeUrl = async () => {\n  await Clipboard.write({ url: 'https://capawesome.io' });\n};\n```\n\n### Read the clipboard content\n\nRead 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:\n\n```typescript\nimport { Clipboard } from '@capawesome/capacitor-clipboard';\n\nconst read = async () => {\n  const { type, value } = await Clipboard.read();\n  console.log('Type:', type, 'Value:', value);\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`read()`](#read)\n* [`write(...)`](#write)\n* [Interfaces](#interfaces)\n* [Enums](#enums)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### read()\n\n```typescript\nread() => Promise<ReadResult>\n```\n\nRead the current content of the system clipboard.\n\nOn Android, reading the clipboard is only possible while the app is in the\nforeground.\n\nOn iOS, reading the clipboard displays a system paste notification. This is\nexpected behavior and cannot be suppressed.\n\n**Returns:** <code>Promise&lt;<a href=\"#readresult\">ReadResult</a>&gt;</code>\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### write(...)\n\n```typescript\nwrite(options: WriteOptions) => Promise<void>\n```\n\nWrite content to the system clipboard.\n\nExactly one of `text`, `html`, `image` or `url` must be provided. The\n`html` property may additionally be combined with `text` to provide a\nplain-text fallback.\n\n| Param         | Type                                                  |\n| ------------- | ----------------------------------------------------- |\n| **`options`** | <code><a href=\"#writeoptions\">WriteOptions</a></code> |\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### ReadResult\n\n| Prop        | Type                                                                  | Description                                                                                     | Since |\n| ----------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----- |\n| **`type`**  | <code><a href=\"#clipboardcontenttype\">ClipboardContentType</a></code> | The type of the content that was read from the clipboard.                                       | 0.1.0 |\n| **`value`** | <code>string</code>                                                   | The content that was read from the clipboard. Images are returned as a Base64-encoded data URL. | 0.1.0 |\n\n\n#### WriteOptions\n\n| Prop        | Type                | Description                                                                                                                                     | Since |\n| ----------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`html`**  | <code>string</code> | 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 |\n| **`image`** | <code>string</code> | The image to write to the clipboard as a Base64-encoded data URL.                                                                               | 0.1.0 |\n| **`label`** | <code>string</code> | The label used to describe the clipboard content. Only available on Android.                                                                    | 0.1.0 |\n| **`text`**  | <code>string</code> | The plain text to write to the clipboard.                                                                                                       | 0.1.0 |\n| **`url`**   | <code>string</code> | The URL to write to the clipboard.                                                                                                              | 0.1.0 |\n\n\n### Enums\n\n\n#### ClipboardContentType\n\n| Members     | Value                | Description                                                     | Since |\n| ----------- | -------------------- | --------------------------------------------------------------- | ----- |\n| **`Html`**  | <code>'HTML'</code>  | The content is HTML.                                            | 0.1.0 |\n| **`Image`** | <code>'IMAGE'</code> | The content is an image, returned as a Base64-encoded data URL. | 0.1.0 |\n| **`Text`**  | <code>'TEXT'</code>  | The content is plain text.                                      | 0.1.0 |\n| **`Url`**   | <code>'URL'</code>   | The content is a URL.                                           | 0.1.0 |\n\n</docgen-api>\n\n## Platform Behavior\n\n### Android\n\n- 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.\n- 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.\n\n### iOS\n\n- 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.\n\n## Migrating from `@capacitor/clipboard`\n\nThis 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:\n\n| `@capacitor/clipboard`                     | `@capawesome/capacitor-clipboard`                      |\n| ------------------------------------------ | ------------------------------------------------------ |\n| `write({ string: 'Hello' })`               | `write({ text: 'Hello' })`                             |\n| `write({ image: dataUrl })` (text-only on Android) | `write({ image: dataUrl })` (real image on all platforms) |\n| —                                          | `write({ html: '<b>Hello</b>', text: 'Hello' })`       |\n| `read() → { value, type: 'text/plain' }`   | `read() → { value, type: 'TEXT' }`                     |\n\n## FAQ\n\n### How is this plugin different from other similar plugins?\n\nIt 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.\n\n### Why is a notification shown when my app reads the clipboard?\n\nOn 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.\n\n### Why does reading the clipboard fail on Android?\n\nOn 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.\n\n### Can I write multiple content types at once?\n\nNo, 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.\n\n### How are images handled by this plugin?\n\nImages 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.\n\n### How is this plugin different from the official `@capacitor/clipboard` plugin?\n\nThis 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.\n\n### Can I use this plugin with Ionic, React, Vue or Angular?\n\nYes, 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.\n\n## Related Plugins\n\n- [Share Target](https://capawesome.io/docs/sdks/capacitor/share-target/): Receive content such as text, links, and files from other apps.\n- [Text Interaction](https://capawesome.io/docs/sdks/capacitor/text-interaction/): Enable and disable text interaction (selection, magnifier, callout menu) in the app's WebView.\n\n## Newsletter\n\nStay 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/).\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/clipboard/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/clipboard/LICENSE).\n","readmeFilename":"README.md"}