From e99e67be36ce628455f0882d896e6157357d9c8a Mon Sep 17 00:00:00 2001 From: severnking <2523913042@qq.com> Date: Tue, 16 Jul 2024 16:28:54 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20[Issues:#IA8JXA]=E6=96=B0=E5=A2=9Ereact?= =?UTF-8?q?-native-share=E6=8C=87=E5=AF=BC=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- zh-cn/react-native-share.md | 257 ++++++++++++++++++++++++++++++++++++ 1 file changed, 257 insertions(+) create mode 100644 zh-cn/react-native-share.md diff --git a/zh-cn/react-native-share.md b/zh-cn/react-native-share.md new file mode 100644 index 00000000..f9334a3b --- /dev/null +++ b/zh-cn/react-native-share.md @@ -0,0 +1,257 @@ + + +> 模板版本：v0.2.2 + +

+

react-native-share

+

+

+ + Supported platforms + + + License + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-share) + + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-share Releases](https://github.com/react-native-oh-library/react-native-share/releases)，并下载适用版本的 tgz 包。 + +进入到工程目录并输入以下命令： + +> [!TIP] # 处替换为 tgz 包的路径 + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-share@file:# +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-share@file:# +``` + + +进入项目的 HarmonyOS 工程 harmony，打开 `entry/src/main/module.json5`，在module中添加：querySchemes字段，表示允许当前应用进行跳转查询的URI schemes，只允许entry类型模块配置，最多50个。例如如需要查询是否可以跳转微博，可以添加 + +```diff + + "querySchemes": [ + "sinaweibo" //三方APP的所支持的scheme，sinaweibo是测试hap的scheme + ] + +``` + +下面的代码展示了这个库的基本使用场景： + +> [!WARNING] 使用时 import 的库名不变。 + +```js + +import RNShare from "react-native-share"; + + RNShare.open({ + url：'https://developer.huawei.com/consumer/cn/' + }).then((res) => { + + }).catch((err) => { + + }) + + RNShare.shareSingle({ + social：'testshare',//testshare为测试包名，需要分享的三方APP名，通过getConstants接口可以拿到所有可以分享的三方APP名称 + title：'分享标题', + subject：'分享摘要', + url：'https://developer.huawei.com/consumer/cn/' + }).then((res) => { + + }).catch((err) => { + + }) +``` + +## 使用 Codegen + +本库已经适配了 `Codegen` ，在使用前需要主动执行生成三方库桥接代码，详细请参考[ Codegen 使用文档](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/codegen.md)。 + +## Link + +目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony` + +### 在工程根目录的 `oh-package.json` 添加 overrides 字段 + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 引入原生端代码 + +目前有两种方法： + +1. 通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）； +2. 直接链接源码。 + +方法一：通过 har 包引入（推荐） + +> [!TIP] har 包位于三方库安装路径的 `harmony` 文件夹下。 + +打开 `entry/oh-package.json5`，添加以下依赖 + +```json + +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-share": "file:../../node_modules/@react-native-oh-tpl/react-native-share/harmony/react_native_share.har" + } + +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +方法二：直接链接源码 + +> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/link-source-code.md) + +### 在 ArkTs 侧引入 RNSharePackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加： + +```diff ++ import {RNSharePackage} from '@react-native-oh-tpl/react-native-share/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new RNSharePackage(ctx) + ]; +} +``` + +### 运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + + +### 兼容性 + + + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-share Releases](https://github.com/react-native-oh-library/react-native-share/releases) + + +本文档内容基于以下版本验证通过： + +1. RNOH: 0.72.27; SDK：HarmonyOS-Next-DB1 5.0.0.25; IDE：DevEco Studio 5.0.3.400SP7; ROM：3.0.0.25; + + +## API + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| getConstants(): ()=> Object | 支持分享的三方APP名称 | fuction | yes | iOS,Android | yes | +| open: (options: ShareOptions) => Promise<{ success: boolean; message: string }> | 系统分享 | fuction | yes | iOS,Android | yes | +| shareSingle: (options: ShareSingleOptions) => Promise<{ success: boolean; message: string }> | 三方分APP分享 | fuction | yes | iOS,Android | no | +| isPackageInstalled: (packagename: string) => Promise | 三方APP是否已在本机安装 | fuction | yes | iOS,Android | no | +| isBase64File: (url: string) => Promise | 分享的URL是否是base64编码格式 | fuction | yes | iOS,Android | yes | + +## ShareOptions + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| type | 分享路径资源类型Mime Typ | string | no | iOS,Android | yes | +| urls | 分享多个路径 | string[] | no | iOS,Android | yes | +| url | 分享路径 | string[] | no | iOS,Android | yes | +| filename | 分享路径文件名 | string | no | iOS,Android | yes | +| filenames | 分享多个路径的文件名（带后缀，如123.png，要与urls对应） | Array | no | iOS,Android | yes | +| message | 分享短信消息文本 | string | no | iOS,Android | yes | +| title | 分享标题 | string | no | iOS,Android | yes | +| subject | 分享内容摘要 | string | no | iOS,Android | yes | +| email | 收件人邮箱地址 | string | no | iOS,Android | no | +| recipient | 接收短信消息的号码 | string | no | iOS,Android | yes | +| excludedActivityTypes | 系统分享面板操作区不应显示的能力列表(harmonyOS中传参例如['0','1']，对应解释为： 0:复制到剪切板,1:保存到媒体库,2:保存到文件管理器 ,3:打印,4:保存到中转站) | string[] | no | iOS,Android | yes | +| failOnCancel | 分享失败的是否抛出异 | boolean | no | iOS,Android | yes | +| showAppsToView | 是否显示可以预览分享文件的APP | boolean | no | Android | no | +| saveToFiles | 是否保存分享的路径文件到本地 | boolean | no | iOS,Android | yes | +| activityItemSources | 系统分享面板操作区应显示的能力列表 | string[] | no | iOS | no | +| isNewTask | 是否开启Activity的启动模式FLAG_ACTIVITY_NEW_TASK | boolean | no | Android | no | + +## ShareSingleOptions + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| social |分享的三方APP名称 | string | yes | iOS,Android | yes | +| appId |三方APP上架市场的appid(social为instagramstories,facebookstories时必传) | string | no | iOS,Android | yes | +| type | 分享路径资源类型Mime Typ | string | no | iOS,Android | yes | +| urls | 分享多个路径 | string[] | no | iOS,Android | yes | +| url | 分享路径 | string[] | no | iOS,Android | yes | +| filename | 分享路径文件名 | string | no | iOS,Android | yes | +| message | 分享短信消息文本 | string | no | iOS,Android | yes | +| title | 分享标题 | string | no | iOS,Android | yes | +| subject | 分享内容摘要 | string | no | iOS,Android | yes | +| email | 收件人邮箱地址 | string | no | iOS,Android | no | +| recipient | 接收短信消息的号码 | string | no | iOS,Android | yes | +| forceDialog | 是否开启三方分享对话框 | boolean | no | Android | no | +| backgroundImage | 背景图像（social为instagramstories,facebookstories传参） | string | no | iOS,Android | no | +| stickerImage | 贴纸图像（social为instagramstories,facebookstories传参） | string | no | iOS,Android | no | +| backgroundBottomColor | 背景底部颜色（social为instagramstories,facebookstories传参） | string | no | iOS,Android | no | +| attributionURL | 属性路径（social为instagramstories,facebookstories传参） | string | no | iOS,Android | no | +| backgroundVideo | 背景视频（social为instagramstories,facebookstories传参） | string | no | iOS,Android | no | + + +## 遗留问题 + +- [ ] 分享三方APP问题：[issue#1](https://github.com/react-native-oh-library/react-native-share/issues/1) + + +## 其他 + +## 开源协议 + +本项目基于 [The MIT License (MIT)](https://github.com/react-native-share/react-native-share/blob/main/LICENSE) ，请自由地享受和参与开源。 + + \ No newline at end of file -- Gitee