{"_id":"@cordova-ohos/cordova-clipboard","_rev":"5-6ebcdec3fb8df4d52308389989c8eb5c","name":"@cordova-ohos/cordova-clipboard","dist-tags":{"latest":"1.3.1"},"versions":{"1.3.0":{"name":"@cordova-ohos/cordova-clipboard","version":"1.3.0","keywords":["cordova","clipboard","ecosystem:cordova","cordova-openharmony"],"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","_id":"@cordova-ohos/cordova-clipboard@1.3.0","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"}],"bugs":{"url":"https://gitcode.com/OpenHarmony-Cordova/cordova-clipboard/issues"},"dist":{"shasum":"71db90ff2065a613b10e069558f01a140e44ae67","tarball":"https://registry.npmjs.org/@cordova-ohos/cordova-clipboard/-/cordova-clipboard-1.3.0.tgz","fileCount":10,"integrity":"sha512-G8DnuHERUqYDhQcwzmxr0A9H8sNDupfq+P0idw29dp+fgsljgDMIQK7fFDMWM11aG65ApVwfkX0aE2doZAmmUw==","signatures":[{"sig":"MEUCIHKM1JwCMaPBVWOzBd0FDDzm6Za5eGiyjRr3VzOjN2PxAiEA34r5TDCvGYUhIKVoD2oTyQlRr/yskCoJSCBGgOVAsD8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":36167},"cordova":{"id":"cordova-clipboard","platforms":["ohos"]},"engines":{"cordovaDependencies":{"1.3.0":{"hcordova":">=1.0.0","@cordova-ohos/ohos":">=2.0.0"}}},"gitHead":"9b2c27c1ad06b950965c4f572db02487fe9d4119","_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"repository":{"url":"gitcode:OpenHarmony-Cordova/cordova-clipboard","type":"git"},"_npmVersion":"10.5.1","description":"Cordova File Transfer Plugin","directories":{},"_nodeVersion":"22.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/cordova-clipboard_1.3.0_1773926620085_0.8481772883590881","host":"s3://npm-registry-packages-npm-production"}},"1.3.1":{"name":"@cordova-ohos/cordova-clipboard","version":"1.3.1","description":"Clipboard management plugin for Cordova/PhoneGap","cordova":{"id":"cordova-clipboard","platforms":["ohos"]},"repository":{"type":"git","url":"gitcode:CPF-Cordova/cordova-clipboard"},"bugs":{"url":"https://gitcode.com/CPF-Cordova/cordova-clipboard/issues"},"keywords":["cordova","clipboard","ecosystem:cordova","cordova-openharmony"],"engines":{"cordovaDependencies":{"1.3.1":{"@cordova-ohos/ohos":">=2.0.0","hcordova":">=1.0.0"}}},"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","_id":"@cordova-ohos/cordova-clipboard@1.3.1","gitHead":"52aaa82d7a96be0e81dc1145ceadc0d05f091eb9","_nodeVersion":"22.0.0","_npmVersion":"10.5.1","dist":{"integrity":"sha512-TZ5EG/hEpQmlx23PqXAiBfjnhR8zyrpQWWvL14zjwKRijpCLuP+0m62jwSYI/Q5+Y8f/rpin2K1o6RPnk1e5rQ==","shasum":"1d18542402f7ad2674fd1dbc71042d0e8b4cbeb1","tarball":"https://registry.npmjs.org/@cordova-ohos/cordova-clipboard/-/cordova-clipboard-1.3.1.tgz","fileCount":11,"unpackedSize":53404,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIE1TfAHXX5idX0uRE33NEDLVWEunGgXyllRTsREwVKW+AiEA882r+UxnmiGq/jwti1Y3ryjq+8Nl5M7fJkCbl2Ig4KY="}]},"_npmUser":{"name":"luqi_tan","email":"295099422@qq.com"},"directories":{},"maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"},{"name":"wanpengsz","email":"wanpengsz@163.com"},{"name":"xkh111","email":"xukaihui11@163.com"},{"name":"hcordova","email":"chenlihuiabc@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cordova-clipboard_1.3.1_1785147712353_0.7295030669254701"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-19T13:23:39.975Z","modified":"2026-07-27T10:21:52.759Z","1.3.0":"2026-03-19T13:23:40.235Z","1.3.1":"2026-07-27T10:21:52.521Z"},"bugs":{"url":"https://gitcode.com/CPF-Cordova/cordova-clipboard/issues"},"author":{"name":"Huawei Device, Inc. Ltd. and","email":"马弓手"},"license":"Apache-2.0","keywords":["cordova","clipboard","ecosystem:cordova","cordova-openharmony"],"repository":{"type":"git","url":"gitcode:CPF-Cordova/cordova-clipboard"},"description":"Clipboard management plugin for Cordova/PhoneGap","maintainers":[{"name":"luqi_tan","email":"295099422@qq.com"},{"name":"wanpengsz","email":"wanpengsz@163.com"},{"name":"xkh111","email":"xukaihui11@163.com"},{"name":"hcordova","email":"chenlihuiabc@163.com"}],"readme":"# <center>cordova-clipboard</center>\r\n\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本项目基于 [cordova-clipboard@1.3.0](https://www.npmjs.com/package/cordova-clipboard/v/1.3.0) 开发，本文档重点阐述其在 OpenHarmony（OHOS）系统中的具体应用。\r\n\r\n- [cordova-clipboard](#cordova-clipboard)\r\n  - [简介](#简介)\r\n  - [支持平台](#支持平台)\r\n  - [下载安装](#下载安装)\r\n    - [从 npm 安装（推荐）](#从-npm-安装推荐)\r\n    - [指定平台安装 ohos](#指定平台安装-ohos)\r\n    - [从 GitCode 仓库安装](#从-gitcode-仓库安装)\r\n    - [安装指定版本](#安装指定版本)\r\n    - [离线安装（本地包）](#离线安装本地包)\r\n    - [安装后验证](#安装后验证)\r\n    - [卸载](#卸载)\r\n  - [约束与限制](#约束与限制)\r\n    - [兼容性](#兼容性)\r\n  - [权限要求](#权限要求)\r\n  - [使用示例](#使用示例)\r\n    - [示例 1：文本复制粘贴](#示例-1文本复制粘贴)\r\n  - [使用说明](#使用说明)\r\n    - [核心 API](#核心-api)\r\n      - [1. 复制文本到剪贴板](#1-复制文本到剪贴板)\r\n        - [方法签名](#方法签名)\r\n        - [参数说明](#参数说明)\r\n      - [2. 从剪贴板粘贴文本](#2-从剪贴板粘贴文本)\r\n        - [方法签名](#方法签名-1)\r\n        - [参数说明](#参数说明-1)\r\n      - [3. 清除剪贴板内容](#3-清除剪贴板内容)\r\n        - [方法签名](#方法签名-2)\r\n        - [参数说明](#参数说明-2)\r\n  - [新增特性](#新增特性)\r\n  - [目录结构](#目录结构)\r\n  - [贡献代码](#贡献代码)\r\n  - [许可证](#许可证)\r\n  - [官方资源](#官方资源)\r\n\r\n## 简介\r\n\r\ncordova-clipboard 是 Harmony Cordova 生态系统中一款核心插件，为 Cordova 应用提供系统剪贴板（Clipboard）操作能力，支持 Android、iOS 和 OHOS 三平台，可实现文本、HTML 及图片的复制与粘贴功能，适配主流移动操作系统剪贴板特性。通过封装原生平台剪贴板 API，为开发者提供了统一的跨平台接口，无需深入原生开发即可实现相关操作，同时处理了不同平台剪贴板数据格式的兼容性问题，本文档主要说明在 OpenHarmony 系统中的应用。\r\n\r\n- 复制文本、HTML 及图片到系统剪贴板\r\n\r\n- 从系统剪贴板粘贴文本、HTML 及图片内容\r\n\r\n- 清空系统剪贴板所有内容\r\n\r\n- 提供统一跨平台接口，适配多系统剪贴板特性\r\n\r\n## 支持平台\r\n\r\n- **Android**：API 19 及以上（Android 4.4+）\r\n\r\n- **iOS**：10.0 及以上\r\n\r\n- **OHOS**：5.0+\r\n\r\n## 下载安装\r\n\r\n通过 hcordova CLI 即可快速安装插件，支持从 npm 仓库或 GitCode 仓库获取。\r\n\r\n### 从 npm 安装（推荐）\r\n\r\n```bash\r\n# 使用 hcordova CLI 安装\r\n# 安装 hcordova 命令行工具\r\nnpm install -g hcordova\r\n\r\n# 全平台安装插件\r\nhcordova plugin add cordova-clipboard\r\n```\r\n\r\n### 指定平台安装 ohos\r\n\r\n仅为 OHOS 平台安装插件：\r\n\r\n```bash\r\n# 仅安装到 OHOS 平台\r\nhcordova plugin add cordova-clipboard --platform ohos\r\n```\r\n\r\n### 从 GitCode 仓库安装\r\n\r\n仅为 OHOS 平台安装插件：\r\n\r\n```bash\r\n# 仅安装到 OHOS 平台\r\nhcordova plugin add https://gitcode.com/CPF-Cordova/cordova-clipboard.git --platform ohos\r\n\r\n# 指定标签/分支安装\r\nhcordova plugin add https://gitcode.com/CPF-Cordova/cordova-clipboard.git@develop --platform ohos\r\n```\r\n\r\n### 安装指定版本\r\n\r\n```bash\r\n# 仅安装到 OHOS 平台指定版本\r\nhcordova plugin add cordova-clipboard@1.0.0 --platform ohos\r\n```\r\n\r\n### 离线安装（本地包）\r\n\r\n适用于无网络环境，先下载插件包到本地，再执行离线安装：\r\n\r\n```bash\r\n# 下载插件包到本地（示例路径：~/Downloads/cordova-clipboard）\r\n# 执行离线安装\r\nhcordova plugin add ~/Downloads/cordova-clipboard --platform ohos\r\n```\r\n\r\n### 安装后验证\r\n\r\n安装完成后，可通过以下命令验证插件是否成功添加到项目中：\r\n\r\n```bash\r\n# 查看已安装的插件列表，若包含本插件 ID 则表示插件已成功安装\r\nhcordova plugin list\r\n```\r\n\r\n### 卸载\r\n\r\n```bash\r\n# Cordova CLI 全平台卸载\r\nhcordova plugin remove cordova-clipboard \r\n\r\n# 指定平台卸载\r\nhcordova plugin remove cordova-clipboard --platform ohos\r\n```\r\n\r\n## 约束与限制\r\n\r\n* 依赖插件：无强制依赖，使用过程中确保 Cordova 设备就绪事件（`deviceready`）已触发。\r\n\r\n* 部分平台可能限制“清除剪贴板内容”操作，使用时需注意平台兼容性。\r\n\r\n### 兼容性\r\n\r\n支持：\r\n\r\n| 项目 | 版本/信息 |\r\n|-----|--------|\r\n| SDK | API12+ |\r\n| IDE | DevEco Studio: 5.0+ |\r\n| ROM | 5.1+ |\r\n| Emulator | OpenHarmony 6.0+ |\r\n\r\n在以下版本中已测试通过：\r\n\r\n| 项目 | 版本/信息 |\r\n|-----|--------|\r\n| @cordova-ohos/ohos | 14.0.1-ohos-14.0.1 |\r\n| SDK | 5.0.0(12) |\r\n| IDE | DevEco Studio: 6.0.13.200 |\r\n| ROM | 5.1.0.120 SP3 |\r\n| Emulator | OpenHarmony 6.0.1(21) |\r\n\r\n## 权限要求\r\n\r\n无特殊权限要求，插件自动适配各平台剪贴板操作所需基础权限，无需额外配置。\r\n\r\n## 使用示例\r\n\r\n### 示例 1：文本复制粘贴\r\n\r\n实现文本框内容复制到剪贴板，以及从剪贴板粘贴到文本框的功能。\r\n\r\n```javascript\r\n// 写剪贴版\r\nfunction clipboardWrite() {\r\n    var text = \"Hello World!\";\r\n    cordova.plugins.clipboard.copy(text,function(){\r\n        document.getElementById(\"writeInfo\").innerHTML = \"写入成功\";\r\n    },function() {\r\n        document.getElementById(\"writeInfo\").innerHTML = \"写入失败\";\r\n    });\r\n}\r\n\r\n// 读取剪贴版\r\nfunction clipboardRead() {\r\n    cordova.plugins.clipboard.paste(function (text) {\r\n        document.getElementById(\"readInfo\").innerHTML = \"读取内容：\"+text;\r\n    },function(error){\r\n        document.getElementById(\"readInfo\").innerHTML = \"读取失败:\"+error;\r\n    });\r\n}\r\n\r\n// 清除剪贴板\r\nfunction  clipboardClear() {\r\n    cordova.plugins.clipboard.clear(function(){\r\n        document.getElementById(\"clearInfo\").innerHTML = \"清除成功\";\r\n    });\r\n}\r\n```\r\n\r\n## 使用说明\r\n\r\n### 核心 API\r\n\r\n插件在全局对象 `window.cordova.plugins.clipboard` 下暴露所有功能接口，支持异步回调和同步调用两种方式（同步调用仅部分 API 支持）。使用前需确保 Cordova 设备就绪事件（`deviceready`）已触发。\r\n\r\n#### 1. 复制文本到剪贴板\r\n\r\n将指定文本内容复制到系统剪贴板，支持纯文本格式。\r\n\r\n##### 方法签名\r\n\r\n```javascript\r\n// 回调方式\r\nwindow.cordova.plugins.clipboard.copy(text, successCallback, errorCallback)\r\n```\r\n\r\n##### 参数说明\r\n\r\n| 参数名 | 类型 | 说明 |\r\n|---|---|---|\r\n| text | String | 必选，需要复制的纯文本内容 |\r\n| successCallback | Function | 可选，成功回调，无参数 |\r\n| errorCallback | Function | 可选，失败回调，参数为错误对象（含 message 属性） |\r\n#### 2. 从剪贴板粘贴文本\r\n\r\n从系统剪贴板中读取文本内容，若剪贴板中为非文本格式则返回空字符串。\r\n\r\n##### 方法签名\r\n\r\n```javascript\r\nwindow.cordova.plugins.clipboard.paste(successCallback, errorCallback)\r\n```\r\n\r\n##### 参数说明\r\n\r\n| 参数名 | 类型 | 说明 |\r\n|---|---|---|\r\n| successCallback | Function | 必选，成功回调，参数为剪贴板中的文本内容（String） |\r\n| errorCallback | Function | 可选，失败回调，参数为错误对象（含 message 属性） |\r\n#### 3. 清除剪贴板内容\r\n\r\n清空系统剪贴板中的所有内容（部分平台可能限制此操作）。\r\n\r\n##### 方法签名\r\n\r\n```javascript\r\nwindow.cordova.plugins.clipboard.clear(successCallback, errorCallback)\r\n```\r\n\r\n##### 参数说明\r\n\r\n| 参数名 | 类型 | 说明 |\r\n|---|---|---|\r\n| successCallback | Function | 可选，成功回调，无参数 |\r\n| errorCallback | Function | 可选，失败回调，参数为错误对象（含 message 属性） |\r\n\r\n## 新增特性\r\n\r\n无新增特性，保持原生插件核心功能，适配 OpenHarmony 平台运行需求。\r\n\r\n## 目录结构\r\n\r\n```\r\ncordova-clipboard/                           # 剪贴板插件根目录\r\n├── LICENSE                                  # 开源许可证\r\n├── OAT.xml                                  # 开源审查配置\r\n├── package.json                             # npm 包配置，定义依赖和版本\r\n├── plugin.xml                               # Cordova 插件核心配置，声明平台和模块\r\n├── README.md                                # 使用说明文档\r\n├── src/                                     # 源代码目录\r\n│   └── main/                                # 主要源码目录\r\n│       ├── cpp/                             # C++ 原生代码\r\n│       │   └── Clipboard/                   # 剪贴板 C++ 模块\r\n│       │       ├── Clipboard.cpp            # C++ 具体功能实现\r\n│       │       └── Clipboard.h              # 头文件\r\n│       └── ets/                             # ArkTS 代码\r\n│           └── components/                  # 组件目录\r\n│               └── PluginAction/            # 插件动作封装\r\n│                   └── ClipboardAction.ets  # 被 C++ 调用，实现授权操作\r\n└── www/                                     # 前端 JS 代码目录\r\n    ├── clipboard.js                         # JS 插件接口，应用调用后转入 C++ 侧\r\n    └── LICENSE                              # 前端代码许可证\r\n```\r\n\r\n## 贡献代码\r\n\r\n使用过程中发现任何问题都可以提 [Issue](https://gitcode.com/CPF-Cordova/cordova-clipboard/issues) ，当然也非常欢迎发 [PR](https://gitcode.com/CPF-Cordova/cordova-clipboard/pulls) 共建。\r\n\r\n## 许可证\r\n\r\n本插件基于 **Apache License 2.0** 开源，详见 [LICENSE](LICENSE) 文件。\r\n\r\n## 官方资源\r\n\r\n- Android 和 iOS：[cordova-clipboard 官方指南](https://www.npmjs.com/package/cordova-clipboard)\r\n\r\n- GitCode 仓库：[CPF-Cordova/cordova-clipboard](https://gitcode.com/CPF-Cordova/cordova-clipboard)\r\n","readmeFilename":"README.md"}