{"_id":"@capacitor-ohos/clipboard","_rev":"2-b0f6c927db65616b08e971a8fb881e99","name":"@capacitor-ohos/clipboard","dist-tags":{"latest":"8.0.2"},"versions":{"8.0.1":{"name":"@capacitor-ohos/clipboard","version":"8.0.1","keywords":["capacitor","plugin","native"],"author":{"url":"Group","name":"Huawei Device Co., Ltd and iSoftStone Information Technology"},"license":"MIT","_id":"@capacitor-ohos/clipboard@8.0.1","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-clipboard/issues"},"dist":{"shasum":"6061b3ad85ccab8b66afdfe0cfeb674e7e419b83","tarball":"https://registry.npmjs.org/@capacitor-ohos/clipboard/-/clipboard-8.0.1.tgz","fileCount":9,"integrity":"sha512-DYkOGrg3ueyzupJaUTQ/2FdYTkt6H9bZVNn37rGGASRCwvOHeHqGzjYFKFuG3w5UWJW9xGGeGVE0vAn/sG2P1Q==","signatures":[{"sig":"MEUCIBZCu9eUDg2Z7S1FHhi8VbVmShi+dxgNgGFBXyRQmIuuAiEA1wZvwlCJYE3knKctuTFk8qIQE9SkG+dz3wqSbWqkS98=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":33707},"gitHead":"1534741dbaccddbceecfcedf9f42859116cc95c5","_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"capacitor":{"id":"@capacitor/clipboard","platforms":["openharmony"]},"repository":{"url":"gitcode:CPF-Ionic/capacitor-clipboard","type":"git"},"_npmVersion":"10.5.1","description":"The Clipboard API enables copy and pasting to/from the system clipboard.","directories":{},"_nodeVersion":"22.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/clipboard_8.0.1_1777541168545_0.7525428901059015","host":"s3://npm-registry-packages-npm-production"}},"8.0.2":{"name":"@capacitor-ohos/clipboard","version":"8.0.2","description":"The Clipboard API enables copy and pasting to/from the system clipboard.","capacitor":{"id":"@capacitor/clipboard","platforms":["openharmony"]},"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-clipboard"},"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-clipboard/issues"},"keywords":["capacitor","plugin","native"],"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","_id":"@capacitor-ohos/clipboard@8.0.2","gitHead":"3811535bb966d8fa300be31d9a07eed1ce91bda9","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-GPWy7MiIoBjXia4SbCGazwqn8vFpNKhSFyP6p96+dSzPnXOF3ZLHXMZuy5imqBTRb6xzs8/XUHOE77Ui3tQByQ==","shasum":"3052eee11bc30f1dcd255153f1d4c9b2f120bfa7","tarball":"https://registry.npmjs.org/@capacitor-ohos/clipboard/-/clipboard-8.0.2.tgz","fileCount":9,"unpackedSize":33731,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGORAg2AwCFymVW74Dfw+EnVmP5Rn47bDh7IZwcF26cvAiEA8cy3/QhdZwUy52lyfZjb0KeZ/0r48JXaXb0qdazf140="}]},"_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"directories":{},"maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/clipboard_8.0.2_1784791384639_0.32842836984019574"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-30T09:26:08.410Z","modified":"2026-07-23T07:23:04.958Z","8.0.1":"2026-04-30T09:26:08.687Z","8.0.2":"2026-07-23T07:23:04.775Z"},"bugs":{"url":"https://gitcode.com/CPF-Ionic/capacitor-clipboard/issues"},"author":{"name":"Huawei Device Co., Ltd and iSoftStone Information Technology","url":"Group"},"license":"MIT","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"gitcode:CPF-Ionic/capacitor-clipboard"},"description":"The Clipboard API enables copy and pasting to/from the system clipboard.","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"readme":"# <center>@capacitor/clipboard</center>\r\n[![zh-CN](https://img.shields.io/badge/lang-中文-blue.svg)](README.md)\r\n[![en](https://img.shields.io/badge/lang-English-blue.svg)](README.en.md)\r\n\r\n本项目基于 [@capacitor/clipboard@8.0.0](https://www.npmjs.com/package/@capacitor/clipboard) 开发。\r\n\r\n## 简介\r\n\r\n`@capacitor/clipboard` 是 capacitor 生态系统中的核心插件，用于向系统剪贴板复制和粘贴内容，为跨平台应用开发提供设备差异化适配能力，兼容 capacitor 的 Android、iOS 等主流移动平台及浏览器环境，本文档主要说明在 OpenHarmony 系统中的使用。\r\n\r\n该插件提供了向系统剪贴板复制文本、图片、URL，以及从剪贴板读取内容的能力，满足移动应用中常见的内容复制、分享、粘贴等场景需求。\r\n\r\n## 支持平台\r\n\r\n- **OpenHarmony**：5.0+\r\n\r\n## 下载安装\r\n\r\n通过命令行或手动引入即可快速安装插件，支持从npm仓库获取。\r\n\r\n### 命令行安装（推荐）\r\n\r\n安装hionic CLI：\r\n\r\n```bash\r\nnpm install -g hionic\r\n```\r\n\r\n以下两种方式中**任选其一**即可，无需重复操作：\r\n\r\nnpm安装：\r\n\r\n```bash\r\n# 安装插件\r\nnpm install @capacitor/clipboard\r\n\r\n# 同步插件\r\nhionic sync openharmony\r\n```\r\n\r\nhionic CLI安装：\r\n\r\n```bash\r\nhionic plugin add @capacitor/clipboard\r\n```\r\n\r\n### 手动引入安装\r\n\r\n根据插件源码中 `plugin.xml` 配置在项目中引入插件：\r\n\r\n#### 1. 添加插件配置\r\n根据 `plugin.xml` 的 `config-json` 项，通过 `target` 字段找到 `entry` 模块中 `capacitor.plugins.json` 文件，并根据 `param` 标签添加配置如下：\r\n\r\n```json\r\n{\r\n    \"pkg\": \"@capacitor/clipboard\",\r\n    \"classpath\": \"Clipboard\"\r\n}\r\n```\r\n\r\n#### 2. 修改 CMake 配置\r\n根据 `plugin.xml` 的 `CMakeLists` 项，通过 `modules-name` 字段找到模块 capacitor，路径为 `target` 字段的 `CMakeLists.txt` 文件，并根据 `param` 标签添加 `add_subdirectory` 和 `target_link_libraries` 如下：\r\n\r\n```cmake\r\n#START_ADD_SUBDIRECTORY\r\n// ...\r\nadd_subdirectory(Clipboard)\r\n// ...\r\n#END_ADD_SUBDIRECTORY\r\n\r\n// ...\r\n\r\ntarget_link_libraries(capacitor PUBLIC\r\n  \"-Wl,--whole-archive\"\r\n  // ...\r\n  Clipboard\r\n  // ...\r\n  \"-Wl,--no-whole-archive\"\r\n)\r\n```\r\n\r\n#### 3. 复制源码文件\r\n根据 `plugin.xml` 的 `source-file` 项，根据 `src` 字段找到需要复制的文件，并根据 `modules-name` 字段和 `target-dir` 字段找到文件复制的具体模块和目录：\r\n\r\n将源码中 src/main/cpp/Clipboard 目录下的 Clipboard.cpp、Clipboard.h、CMakeLists.txt 文件引入到 capacitor 模块中 src/main/cpp/Clipboard 目录下。\r\n\r\n## 卸载\r\n\r\n```bash\r\n# 卸载 clipboard 插件\r\nhionic plugin remove @capacitor/clipboard\r\n```\r\n\r\n## 约束与限制\r\n\r\n### 兼容性\r\n\r\n在以下版本中已测试通过：\r\n\r\n1. SDK: 5.0.5(17); IDE: DevEco Studio: 6.0.0; ROM: 5.1.0.150;\r\n\r\n### 权限要求\r\n\r\nOpenHarmony 需要申请读取剪贴板权限，在主工程的 `module.json5` 的 `requestPermissions` 添加 `ohos.permission.READ_PASTEBOARD` 权限，示例如下：\r\n\r\n```json\r\n{\r\n  \"name\" : \"ohos.permission.READ_PASTEBOARD\",\r\n  \"reason\": \"$string:pasteboard\",\r\n  \"usedScene\": {\r\n    \"abilities\": [\r\n      \"EntryAbility\"\r\n    ],\r\n    \"when\": \"always\"\r\n  }\r\n}\r\n```\r\n\r\n更多权限说明参考：[申请应用权限](https://docs.openharmony.cn/pages/v5.1.0/zh-cn/application-dev/basic-services/pasteboard/get-pastedata-permission-guidelines.md)。\r\n\r\n## 使用示例\r\n\r\n### 基础示例：写入剪切板并读取\r\n\r\n```javascript\r\nimport { Clipboard } from '@capacitor/clipboard';\r\n\r\nconst writeToClipboard = async () => {\r\n  await Clipboard.write({\r\n    string: \"Hello World!\"\r\n  });\r\n};\r\n\r\nconst checkClipboard = async () => {\r\n  const { type, value } = await Clipboard.read();\r\n\r\n  console.log(`Got ${type} from clipboard: ${value}`);\r\n};\r\n```\r\n\r\n## 使用说明\r\n\r\n### 接口方法\r\n\r\n| 方法名 | 返回类型 | 描述 |\r\n| ---- | ---- | ---- |\r\n| write(options: [WriteOptions](#writeoptions)) | Promise&lt;void&gt; | 将值写入剪贴板 |\r\n| read() | Promise&lt;[ReadResult](#readresult)&gt; | 从剪贴板读取值 |\r\n\r\n### 数据结构\r\n\r\n#### WriteOptions\r\n\r\n要写入剪贴板的数据：\r\n\r\n| 属性名       | 类型   | 描述                                                         | 备注         |\r\n| ------------ | ------ | ------------------------------------------------------------ | ------------ |\r\n| **`string`** | string | 要复制的文本值                                              |              |\r\n| **`image`**  | string | 图片 [数据 URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) 复制格式 |              |\r\n| **`url`**    | string | 要复制的 URL 字符串                                           |              |\r\n| **`label`**  | string | 用户可见标签，用于标记复制的数据                            | 仅限 Android |\r\n\r\n#### ReadResult\r\n\r\n从剪贴板读取的数据：\r\n\r\n| 属性名      | 类型   | 描述                |\r\n| ----------- | ------ | ------------------- |\r\n| **`value`** | string | 从剪贴板读取数据   |\r\n| **`type`**  | string | 剪贴板中的数据类型 |\r\n\r\n## 目录结构\r\n\r\n```\r\n|---- 项目根目录\r\n|     |---- src\r\n|           |---- main\r\n|                 |---- cpp\r\n|                       |---- Clipboard   # 插件核心 C++ 实现\r\n|                             |---- Clipboard.cpp\r\n|                             |---- Clipboard.h\r\n|                             |---- CMakeLists.txt\r\n|     |---- README.md          # 说明文档\r\n|     |---- package.json       # npm 配置文件\r\n|     |---- plugin.xml         # capacitor 插件配置\r\n|     |---- LICENSE            # 许可证文件\r\n```\r\n\r\n## 贡献代码\r\n\r\n使用过程中发现任何问题都可以提 [Issue](https://gitcode.com/CPF-Ionic/capacitor-clipboard/issues)，当然，也非常欢迎发 [PR](https://gitcode.com/CPF-Ionic/capacitor-clipboard/pulls) 共建。\r\n\r\n## 许可证\r\n\r\n本插件基于 **MIT License** 开源，详见 [LICENSE](./LICENSE) 文件。\r\n","readmeFilename":"README.md"}