From b8c056570e8bc5cc7ed30bf7b5250c354f35c78e Mon Sep 17 00:00:00 2001
From: xiong <xiongwenshuai1@h-partners.com>
Date: Wed, 24 Jul 2024 15:15:00 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20[Issues:=20#IAEP7X]=20=E6=96=B0?=
 =?UTF-8?q?=E5=A2=9Ereact-native-version-number=E6=8C=87=E5=AF=BC=E6=96=87?=
 =?UTF-8?q?=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 zh-cn/react-native-version-number.md | 169 +++++++++++++++++++++++++++
 1 file changed, 169 insertions(+)
 create mode 100644 zh-cn/react-native-version-number.md

diff --git a/zh-cn/react-native-version-number.md b/zh-cn/react-native-version-number.md
new file mode 100644
index 00000000..70c44dab
--- /dev/null
+++ b/zh-cn/react-native-version-number.md
@@ -0,0 +1,169 @@
+模板版本：v0.2.2
+
+<p align="center">
+  <h1 align="center"> <code>react-native-version-number</code> </h1>
+</p>
+
+<p align="center">
+    <a href="https://github.com/APSL/react-native-version-number">
+        <img src="https://img.shields.io/badge/platforms-android%20|%20ios%20|%20harmony%20-lightgrey.svg" alt="Supported platforms" />
+    </a>
+    <a href="https://github.com/APSL/react-native-version-number/blob/master/LICENSE">
+        <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License" />
+    </a>
+</p>
+
+> [!TIP] [Github 地址](https://github.com/APSL/react-native-version-number)
+
+## 安装与使用
+
+请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-version-number Releases](https://github.com/APSL/react-native-version-number/blob/master/LICENSE)，并下载适用版本的 tgz 包。
+
+进入到工程目录并输入以下命令：
+
+> [!TIP] # 处替换为 tgz 包的路径
+
+<!-- tabs:start -->
+
+#### **npm**
+
+```bash
+npm install @react-native-oh-tpl/react-native-version-number@file:#
+```
+
+#### **yarn**
+
+```bash
+yarn add @react-native-oh-tpl/react-native-version-number@file:#
+```
+
+<!-- tabs:end -->
+
+下面的代码展示了这个库的基本使用场景：
+
+> [!WARNING] 使用时 import 的库名不变。
+
+```js
+import React, { useState } from "react";
+import { View, Text } from "react-native";
+import VersionNumber from "react-native-version-number";
+
+export default function App() {
+  return (
+    <View>
+      <Text>{VersionNumber.appVersion}</Text>
+      <Text>{VersionNumber.buildVersion}</Text>
+      <Text>{VersionNumber.bundleIdentifier}</Text>
+    </View>
+  );
+}
+```
+
+## Link
+
+目前鸿蒙暂不支持 AutoLink，所以 Link 步骤需要手动配置。
+
+首先需要使用 DevEco Studio 打开项目里的鸿蒙工程 `harmony`
+
+### 在工程根目录的 `oh-package.json` 添加 overrides字段
+
+```json
+{
+  ...
+  "overrides": {
+    "@rnoh/react-native-openharmony" : "file:./react_native_openharmony"
+  }
+}
+```
+
+## 使用 Codegen
+
+本库已经适配了 `Codegen` ，在使用前需要主动执行生成三方库桥接代码，详细请参考[ Codegen 使用文档](/zh-cn/codegen.md)。
+
+### 引入原生端代码
+
+目前有两种方法：
+
+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-bars": "file:../../node_modules/@react-native-oh-tpl/react-native-version-number/harmony/VersionNumber.har"
+    
+  }
+```
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+方法二：直接链接源码
+
+> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md)
+
+
+### 在 ArkTs 侧引入 RNBarsPackage
+
+打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加：
+
+```diff
+...
++ import {RNVersionNumberPackage} from '@react-native-oh-tpl/react-native-version-number/ts';
+
+export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
+  return [
+    new SamplePackage(ctx),
++   new RNVersionNumberPackage(ctx)
+  ];
+}
+```
+
+### 运行
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+
+然后编译、运行即可。
+
+### 兼容性
+
+要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。
+
+请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-version-number Releases](https://github.com/APSL/react-native-version-number/blob/master/LICENSE)
+
+
+## 属性
+
+> [!tip] "Platform"列表示该属性在原三方库上支持的平台。
+
+> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。
+
+| Props         | Description                                     | Type   | Required | Platform | HarmonyOS Support |
+| ------------- | ----------------------------------------------- | ------ | -------- | -------- | ----------------- |
+| VersionNumber | object,appVersion,buildVersion,bundleIdentifier | object | no       | all      | yes               |
+
+## 遗留问题
+
+## 其他
+
+## 开源协议
+
+本项目基于 [The MIT License (MIT)](https://github.com/APSL/react-native-version-number/blob/master/LICENSE) ，请自由地享受和参与开源。
-- 
Gitee