文档模板：v0.4.2

react-native-clipboard/clipboard

本项目基于 react-native-clipboard/clipboard 开发。

该第三方库的仓库已迁移至 Gitcode，且支持直接从 npm 下载，新的包名为：@react-native-ohos/clipboard。版本所属关系如下：

简介

react-native-clipboard/clipboard 是一个用于访问剪贴板内容的 React Native 库。

下载安装

进入到工程目录并输入以下命令：

npm

npm install @react-native-ohos/clipboard

yarn

yarn add @react-native-ohos/clipboard

Link

使用AutoLink的工程需要根据该文档配置，Autolink框架指导文档：https://gitcode.com/CPF-RN/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md

如您使用的版本支持 Autolink，并且工程已接入 Autolink，可跳过ManualLink配置。

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",

    "@react-native-ohos/clipboard": "file:../../node_modules/@react-native-ohos/clipboard/harmony/clipboard.har"
  }

cd entry
ohpm install

project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(CMAKE_SKIP_BUILD_RPATH TRUE)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
set(NODE_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../node_modules")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")
set(LOG_VERBOSITY_LEVEL 1)
set(CMAKE_ASM_FLAGS "-Wno-error=unused-command-line-argument -Qunused-arguments")
set(CMAKE_CXX_FLAGS "-fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -s -fPIE -pie")
set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use
add_compile_definitions(WITH_HITRACE_SYSTRACE)

add_subdirectory("${RNOH_CPP_DIR}" ./rn)

# RNOH_BEGIN: manual_package_linking_1
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/clipboard/src/main/cpp" ./clipboard)
# RNOH_END: manual_package_linking_1

file(GLOB GENERATED_CPP_FILES "./generated/*.cpp")

add_library(rnoh_app SHARED
    ${GENERATED_CPP_FILES}
    "./PackageProvider.cpp"
    "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)
target_link_libraries(rnoh_app PUBLIC rnoh)

# RNOH_BEGIN: manual_package_linking_2
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_clipboard)
# RNOH_END: manual_package_linking_2

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "ClipboardPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
        std::make_shared<RNOHGeneratedPackage>(ctx),
        std::make_shared<SamplePackage>(ctx),
+       std::make_shared<ClipboardPackage>(ctx),
    };
}

import type {RNPackageContext, RNPackage} from 'rnoh/ts';
import {SamplePackage} from 'rnoh-sample-package/ts';
+ import {ClipboardPackage} from '@react-native-ohos/clipboard/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new ClipboardPackage(ctx)
  ];
}

运行

点击右上角的 sync 按钮

或者在命令行终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

本文档内容基于以下环境验证通过：

1. RNOH: 0.82.22; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.878; ROM: 6.0.0.130;
2. RNOH: 0.84.2; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1.260; ROM:6.0.0.130;

权限要求

"ohos.permission.READ_PASTEBOARD"权限等级为system_basic，授权方式为user_grant，使用 ACL 签名的配置指导

在 entry 目录下的module.json5中添加权限

打开 entry/src/main/module.json5，添加：

...
"requestPermissions": [
+  {
+    "name": "ohos.permission.READ_PASTEBOARD",
+    "reason": "$string:Access_clipboard",
+    "usedScene": {
+      "abilities": [
+        "EntryAbility"
+      ],
+      "when":"always"
+    }
+  },
]

在 entry 目录下添加申请剪切板权限的原因

打开 entry/src/main/resources/base/element/string.json，添加：

...
{
  "string": [
+    {
+      "name": "Access_clipboard",
+      "value": "access clipboard"
+    }
  ]
}

使用示例

下面的代码展示了这个库的基本使用场景：

import React, { useState } from 'react';
import { StyleSheet, Text, TouchableOpacity, View } from 'react-native';
import Clipboard from "@react-native-clipboard/clipboard";

const App = () => {
  const [copiedText, setCopiedText] = useState("");

  const copyToClipboard = () => {
    Clipboard.setString("hello world");
  };

  const fetchCopiedText = async () => {
    try {
      const text = await Clipboard.getString();
      setCopiedText(text);
    } catch (error) {
      // getString / hasString 等 Promise 方法在用户拒绝剪贴板权限时会 reject
      console.error('Failed to read clipboard:', error);
    }
  };

  return (
    <View style={styles.container}>
      <TouchableOpacity onPress={copyToClipboard}>
        <Text>Click here to copy to Clipboard</Text>
      </TouchableOpacity>
      <TouchableOpacity onPress={fetchCopiedText}>
        <Text>View copied text</Text>
      </TouchableOpacity>

      <Text style={styles.copiedText}>{copiedText}</Text>
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: "center",
    alignItems: "center",
    padding: 20,
  },
  copiedText: {
    marginTop: 20,
    fontSize: 18,
  },
});

export default App;

接口说明

API

遗留问题

其他

无

目录结构

/rntpc_clipboard                  # 项目根目录
├── harmony                       # 鸿蒙适配代码
│    ├─ clipboard.har             # har 包
│    └─ clipboard                 # 鸿蒙适配核心代码
│          ├─ index.ets           # 鸿蒙适配代码入口
│          ├─ ts.ets              # 类型导出
│          ├─ oh-package.json5    # 鸿蒙模块包配置
│          ├─ build-profile.json5 # 鸿蒙模块构建配置
│          ├─ hvigorfile.ts       # 鸿蒙模块构建脚本
│          └─ src/main
│              ├─ module.json5                     # 鸿蒙模块声明
│              ├─ cpp
│              │    ├─ CMakeLists.txt              # C++ 构建配置
│              │    ├─ ClipboardPackage.h          # 包封装头文件
│              │    ├─ RNCClipboardTurboModule.cpp # C++ TurboModule 实现
│              │    └─ RNCClipboardTurboModule.h   # C++ TurboModule 头文件
│              ├─ ets
│              │    ├─ ClipboardPackage.ets        # clipboard 包封装
│              │    ├─ Logger.ts                   # 日志工具
│              │    └─ RNCClipboardTurboModule.ts  # 原生模块实现
│              └─ resources                        # 鸿蒙模块资源
├── src                           # RN 源码
│    ├─ Clipboard.ts              # 剪贴板 API 实现
│    ├─ NativeClipboardModule.ts  # TurboModule 规格与原生桥接
│    ├─ useClipboard.ts           # 剪贴板 React Hook
│    └─ index.ts                  # 入口文件
├── README_en.md                  # 英文说明文档
└── README.md                     # 中文说明文档

贡献代码

使用过程中发现任何问题都可以提交 Issue，当然，也非常欢迎提交 PR。

开源协议

本项目基于 The MIT License (MIT) ，请自由地享受和参与开源。