From 18ffe1d14866a35c7d4c2ff903ce38775578b556 Mon Sep 17 00:00:00 2001
From: ljje <1370314186@qq.com>
Date: Wed, 14 Aug 2024 19:18:23 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20[Issues:=20#IAJKTZ]=20=E6=96=B0?=
 =?UTF-8?q?=E5=A2=9Ereact-native-localization-settings=E6=8C=87=E5=AF=BC?=
 =?UTF-8?q?=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-localization-settings.md | 235 ++++++++++++++++++++
 1 file changed, 235 insertions(+)
 create mode 100644 zh-cn/react-native-localization-settings.md

diff --git a/zh-cn/react-native-localization-settings.md b/zh-cn/react-native-localization-settings.md
new file mode 100644
index 00000000..ebe05cf3
--- /dev/null
+++ b/zh-cn/react-native-localization-settings.md
@@ -0,0 +1,235 @@
+> 模板版本：v0.2.2
+
+<p align="center">
+  <h1 align="center"> <code>react-native-localization-settings</code> </h1>
+</p>
+<p align="center">
+    <a href="https://github.com/jakex7/react-native-localization-settings">
+        <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/jakex7/react-native-localization-settings/blob/main/LICENSE">
+        <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License" />
+        <!-- <img src="https://img.shields.io/badge/license-Apache-blue.svg" alt="License" /> -->
+    </a>
+</p>
+
+> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-localization-settings)
+
+## 安装与使用
+
+请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-localization-settings Releases](https://github.com/react-native-oh-library/react-native-localization-settings/releases)，并下载适用版本的 tgz 包。
+
+进入到工程目录并输入以下命令：
+
+> [!TIP] # 处替换为 tgz 包的路径
+
+<!-- tabs:start -->
+
+#### **npm**
+
+```bash
+npm install @react-native-oh-tpl/react-native-localization-settings@file:#
+```
+
+#### **yarn**
+
+```bash
+yarn add @react-native-oh-tpl/react-native-localization-settings@file:#
+```
+
+<!-- tabs:end -->
+
+下面的代码展示了这个库的基本使用场景：
+
+> [!WARNING] 使用时 import 的库名不变。
+
+```js
+import * as React from "react";
+import { StyleSheet, View, Text, Button } from "react-native";
+import { ReactNativeLanguageDetector } from "react-native-localization-settings";
+import i18next from "i18next";
+import { initReactI18next, useTranslation } from "react-i18next";
+
+i18next
+  .use(ReactNativeLanguageDetector)
+  .use(initReactI18next)
+  .init({
+    resources: {
+      en: {
+        translation: {
+          key: "hello world in english",
+        },
+      },
+      pl: {
+        translation: {
+          key: "hello world in polish",
+        },
+      },
+      fr: {
+        translation: {
+          key: "hello world in french",
+        },
+      },
+    },
+    fallbackLng: "en",
+    interpolation: {
+      escapeValue: false,
+    },
+    compatibilityJSON: "v3",
+  });
+
+export default function App() {
+  const { t } = useTranslation();
+
+  return (
+    <View style={styles.container}>
+      <Text>{t("key")}</Text>
+      <Button
+        title={"change to pl"}
+        onPress={() => i18next.changeLanguage("pl-PL")}
+      />
+      <Button
+        title={"change to en"}
+        onPress={() => i18next.changeLanguage("en-US")}
+      />
+      <Button
+        title={"change to fr"}
+        onPress={() => i18next.changeLanguage("fr-FR")}
+      />
+    </View>
+  );
+}
+
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+    alignItems: "center",
+    justifyContent: "center",
+  },
+  box: {
+    width: 60,
+    height: 60,
+    marginVertical: 20,
+  },
+});
+```
+
+## 使用 Codegen
+
+本库已经适配了 `Codegen` ，在使用前需要主动执行生成三方库桥接代码，详细请参考[ Codegen 使用文档](/zh-cn/codegen.md)。
+
+## Link
+
+目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。
+
+首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony`
+
+### 在工程根目录的 `oh-package.json5` 添加 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-localization-settings": "file:../../node_modules/@react-native-oh-tpl/react-native-localization-settings/harmony/localization_settings.har"
+  }
+```
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+
+方法二：直接链接源码
+
+> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md)
+
+### 在 ArkTs 侧引入 RNLocalizationSettingsPackage
+
+打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加：
+
+```diff
+  ...
++ import {RNLocalizationSettingsPackage} from '@react-native-oh-tpl/react-native-localization-settings/ts';
+
+export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
+  return [
+    new SamplePackage(ctx),
++   new RNLocalizationSettingsPackage(ctx)
+  ];
+}
+```
+
+### 运行
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+
+然后编译、运行即可。
+
+## 约束与限制
+
+### 兼容性
+
+要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。
+
+请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-localization-settings Releases](https://github.com/react-native-oh-tpl/react-native-localization-settings/releases)
+
+## 静态方法
+
+> [!tip] "Platform"列表示该属性在原三方库上支持的平台。
+
+> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。
+
+| Name                       | Description               | Type     | Required | Platform    | HarmonyOS Support |
+| -------------------------- | ------------------------- | -------- | -------- | ----------- | ----------------- |
+| I18nLanguageDetectorModule | i18next language detector | function | no       | iOS/Android | yes               |
+
+## API
+
+> [!tip] "Platform"列表示该属性在原三方库上支持的平台。
+
+> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。
+
+| Name          | Description                           | Type     | Required | Platform    | HarmonyOS Support |
+| ------------- | ------------------------------------- | -------- | -------- | ----------- | ----------------- |
+| getLanguage() | Function to get current language.     | function | no       | iOS/Android | yes               |
+| setLanguage() | Function to set the current language. | function | no       | iOS/Android | yes               |
+
+## 遗留问题
+
+## 其他
+
+## 开源协议
+
+本项目基于 [The MIT License (MIT)](https://github.com/jakex7/react-native-localization-settings/blob/main/LICENSE) ，请自由地享受和参与开源。
-- 
Gitee