From 4116d7986e5a94baf0fe034081f1f079b8cac41d Mon Sep 17 00:00:00 2001 From: sesont97 Date: Mon, 1 Dec 2025 18:02:26 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E8=BF=81=E7=A7=BB?= =?UTF-8?q?=E5=A3=B0=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: sesont97 --- README.md | 20 ++--- doc/en.md | 216 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/zh-cn.md | 214 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 440 insertions(+), 10 deletions(-) create mode 100644 doc/en.md create mode 100644 doc/zh-cn.md diff --git a/README.md b/README.md index 0078088..c683484 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# @react-native-oh-tpl/react-native-user-agent +# 迁移声明 -## 文档地址 / Documentation URL +- 本仓库已迁移至 GitCode：[OpenHarmony-SIG/rntpc_react-native-user-agent](https://gitcode.com/openharmony-sig/rntpc_react-native-user-agent)。 +- 包名已更改为 `@react-native-ohos/react-native-user-agent`，支持直接从 npm 下载。 +- 更多详情请查阅新仓库的 README 文件。 +- 本仓库旧版本的文档已归档：[链接](/doc/zh-cn.md) -[中文 / Chinese](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-user-agent.md) +# Migration Announcement -## Codegen - -该库已接入 codegen，具体请查阅文档。 - -## 请悉知 / Acknowledgements - -本项目基于 [The MIT License (MIT)](https://github.com/react-native-oh-library/react-native-user-agent/blob/sig/LICENSE) ，请自由地享受和参与开源。 +- This repository has been migrated to GitCode：[OpenHarmony-SIG/rntpc_react-native-user-agent](https://gitcode.com/openharmony-sig/rntpc_react-native-user-agent) +- The package name has been changed to `@react-native-ohos/react-native-user-agent` and is now available for direct download from npm. +- For more details, please refer to the README in the new repository. +- Archived documentation for versions in this repository can be found here: [Link](/doc/en.md) diff --git a/doc/en.md b/doc/en.md new file mode 100644 index 0000000..4a81618 --- /dev/null +++ b/doc/en.md @@ -0,0 +1,216 @@ +> Template version: v0.2.2 + +

+

react-native-user-agent

+

+

+ + Supported platforms + + + License + + +

+ + +> [!TIP] [Github address](https://github.com/react-native-oh-library/react-native-user-agent) + +## Installation and Usage + +Find the matching version information in the release address of a third-party library and download an applicable .tgz package: [@react-native-oh-tpl/react-native-user-agent Releases](https://github.com/react-native-oh-library/react-native-user-agent/releases). + +Go to the project directory and execute the following instruction: + + + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-user-agent +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-user-agent +``` + + + +The following code shows the basic use scenario of the repository: + +> [!WARNING] The name of the imported repository remains unchanged. + +```js +import React, { useState, useEffect } from 'react'; +import { View, Text } from 'react-native'; +import UserAgent from 'react-native-user-agent'; + +// sync method: +let userAgent: string = UserAgent.getUserAgent(); + +export default function UserAgentExample() { + const [webViewUserAgent, setWebViewUserAgent] = useState(null); + useEffect(() => { + // async method: + UserAgent.getWebViewUserAgent() + .then(webViewUserAgent => { + setWebViewUserAgent(webViewUserAgent); + console.log(webViewUserAgent); + }) + .catch(e => { + console.error('Error getting WebView User Agent:', e); + }); + }, []); + return ( + + Sync method: + {userAgent} + + Async method + {webViewUserAgent} + + Property: + systemName: {UserAgent.systemName} + systemVersion: {UserAgent.systemVersion} + applicationName: {UserAgent.applicationName} + applicationVersion: {UserAgent.applicationVersion} + buildNumber: {UserAgent.buildNumber} + + ); +}; + +``` + +## Use Codegen + +If this repository has been adapted to Codegen, generate the bridge code of the third-party library by using the Codegen. For details, see[ Codegen Usage Guide](/en/codegen.md). + +## Link + +Currently, HarmonyOS does not support AutoLink. Therefore, you need to manually configure the linking. + +Open the harmony directory of the HarmonyOS project in DevEco Studio. + +### 1.Adding the overrides Field to oh-package.json5 File in the Root Directory of the Project + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony": "./react_native_openharmony" + } +} +``` + +### 2.Introducing Native Code + +Currently, two methods are available: + +1. (recommended): Use the HAR file. +2. Directly link to the source code. + +Method 1 (recommended): Use the HAR file. + +> [!TIP] The HAR file is stored in the harmony directory in the installation path of the third-party library. + +Open entry/oh-package.json5 file and add the following dependencies: + +```json +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-user-agent": "file:../../node_modules/@react-native-oh-tpl/react-native-user-agent/harmony/user_agent.har" + } +``` + +Click the sync button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Method 2: Directly link to the source code. + +> [!TIP] For details, see [Directly Linking Source Code](/en/link-source-code.md). + +### 3.Introducing RNUserAgentPackage Package to ArkTS + +Open the entry/src/main/ets/RNPackagesFactory.ts file and add the following code: + +```diff + ... + ++ import { RNUserAgentPackage } from '@react-native-oh-tpl/react-native-user-agent/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ ++ new RNUserAgentPackage(ctx) + ]; +} +``` + +### 4.Running + +Click the sync button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Then build and run the code. + +## Constraints + +### Compatibility + +To use this repository, you need to use the correct React-Native and RNOH versions. In addition, you need to use DevEco Studio and the ROM on your phone. + +Check the release version information in the release address of the third-party library: [@react-native-oh-tpl/react-native-user-agent Releases](https://github.com/react-native-oh-library/react-native-user-agent/releases) + +## Properties + +> [!tip] The Platform column indicates the platform where the properties are supported in the original third-party library. + +> [!tip] If the value of HarmonyOS Support is yes, it means that the HarmonyOS platform supports this property; no means the opposite; partially means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android. + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ------------------ | ------------------- | ------ | -------- | -------- | ----------------- | +| systemName | System Name | string | no | All | yes | +| systemVersion | System Version | string | no | All | yes | +| applicationName | Application Name | string | no | All | yes | +| applicationVersion | Application Version | string | no | All | yes | +| buildNumber | Build Number | string | no | All | yes | +| darwinVersion | Darwin Version | string | no | iOS | no | +| cfnetworkVersion | Cfnetwork Version | string | no | iOS | no | +| modelName | Model Name | string | no | iOS | no | +| deviceName | Device Name | string | no | iOS | no | + +## API + +> [!tip] The Platform column indicates the platform where the properties are supported in the original third-party library. + +> [!tip] If the value of HarmonyOS Support is yes, it means that the HarmonyOS platform supports this property; no means the opposite; partially means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android. + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ------------------- | ----------------------------- | ------- | -------- | -------- | ----------------- | +| getUserAgent | Get user agent synchronously | string | no | All | yes | +| getWebViewUserAgent | Get user agent asynchronously | Promise | no | All | yes | + +## Known Issues + +## Others + +Depending on HarmonyOS NEXT Developer Beta3 version default UserAgent definition, word ArkWeb VersionCode (ArkWeb version number) has no receive method currently, waiting for completion afterwards. + +## License + +This project is licensed under [The MIT License (MIT)](https://github.com/bebnev/react-native-user-agent/blob/master/LICENSE). diff --git a/doc/zh-cn.md b/doc/zh-cn.md new file mode 100644 index 0000000..0181d06 --- /dev/null +++ b/doc/zh-cn.md @@ -0,0 +1,214 @@ +> 模板版本：v0.2.2 + +

+

react-native-user-agent

+

+

+ + Supported platforms + + + License + + +

+ + +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-user-agent) + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-user-agent Releases](https://github.com/react-native-oh-library/react-native-user-agent/releases) 。对于未发布到npm的旧版本，请参考[安装指南](/zh-cn/tgz-usage.md)安装tgz包。 + +进入到工程目录并输入以下命令： + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-user-agent +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-user-agent +``` + + + +下面的代码展示了这个库的基本使用场景： + +> [!WARNING] 使用时 import 的库名不变。 + +```js +import React, { useState, useEffect } from 'react'; +import { View, Text } from 'react-native'; +import UserAgent from 'react-native-user-agent'; + +// 同步方式： +let userAgent: string = UserAgent.getUserAgent(); + +export default function UserAgentExample() { + const [webViewUserAgent, setWebViewUserAgent] = useState(null); + useEffect(() => { + // 异步方式： + UserAgent.getWebViewUserAgent() + .then(webViewUserAgent => { + setWebViewUserAgent(webViewUserAgent); + console.log(webViewUserAgent); + }) + .catch(e => { + console.error('Error getting WebView User Agent:', e); + }); + }, []); + return ( + + 同步方式： + {userAgent} + + 异步方式： + {webViewUserAgent} + + 属性： + systemName: {UserAgent.systemName} + systemVersion: {UserAgent.systemVersion} + applicationName: {UserAgent.applicationName} + applicationVersion: {UserAgent.applicationVersion} + buildNumber: {UserAgent.buildNumber} + + ); +}; + +``` + +## 使用 Codegen + +本库已经适配了 `Codegen` ，在使用前需要主动执行生成三方库桥接代码，详细请参考[ Codegen 使用文档](/zh-cn/codegen.md)。 + +## Link + +目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony` + +### 1.在工程根目录的 `oh-package.json5` 添加 overrides 字段 + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony": "./react_native_openharmony" + } +} +``` + +### 2.引入原生端代码 + +目前有两种方法： + +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-user-agent": "file:../../node_modules/@react-native-oh-tpl/react-native-user-agent/harmony/user_agent.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +方法二：直接链接源码 + +> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md) + +### 3.在 ArkTs 侧引入 RNUserAgentPackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加： + +```diff + ... + ++ import { RNUserAgentPackage } from '@react-native-oh-tpl/react-native-user-agent/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ ++ new RNUserAgentPackage(ctx) + ]; +} +``` + +### 4.运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-user-agent Releases](https://github.com/react-native-oh-library/react-native-user-agent/releases) + +## 属性 + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| systemName | System Name | string | no | All | yes | +| systemVersion | System Version | string | no | All | yes | +| applicationName | Application Name | string | no | All | yes | +| applicationVersion | Application Version | string | no | All | yes | +| buildNumber | Build Number | string | no | All | yes | +| darwinVersion | Darwin Version | string | no | iOS | no | +| cfnetworkVersion | Cfnetwork Version | string | no | iOS | no | +| modelName | Model Name | string | no | iOS | no | +| deviceName | Device Name | string | no | iOS | no | + +## API + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| getUserAgent | Get user agent synchronously | string | no | All | yes | +| getWebViewUserAgent | Get user agent asynchronously | Promise | no | All | yes | + +## 遗留问题 + +## 其他 + +根据 HarmonyOS NEXT Developer Beta3 版本默认 UserAgent 定义，字段 ArkWeb VersionCode (ArkWeb 版本号) 暂无获取方式，待后续完善。 + +## 开源协议 + +本项目基于 [The MIT License (MIT)](https://github.com/bebnev/react-native-user-agent/blob/master/LICENSE) ，请自由地享受和参与开源。 \ No newline at end of file