模板版本:v0.4.0

react-native-localization-settings

Supported platforms License

本项目基于 原库react-native-localization-settings 开发。

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

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-localization-settings ~1.3.0 Gitcode Releases 0.82 API12+ 1.2.0 Npm Address
@react-native-ohos/react-native-localization-settings ~1.2.1 Gitcode Releases 0.77 API12+ 1.2.0 Npm Address
@react-native-ohos/react-native-localization-settings ~1.0.3 Gitcode Releases 0.72 API12+ 1.0.2 Npm Address
@react-native-oh-tpl/react-native-localization-settings <= 1.0.2-0.0.1@deprecated @react-native-oh-tpl/react-native-localization-settings Releases(deprecated) 0.72 API12+ 1.0.2 Npm Address

1.安装与使用

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

npm

npm install @react-native-ohos/react-native-localization-settings

yarn

yarn add @react-native-ohos/react-native-localization-settings

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

使用时 import 的库名不变。

本示例依赖i18next react-i18next库,参照[react-i18next文档](https://react.i18next.com/guides/quick-start)进行引入

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,
  },
});
是否支持autolink RN框架版本
~1.3.0 Yes 0.82
~1.2.1 No 0.77
~1.0.3 Yes 0.72
<= 1.0.2-0.0.1@deprecated No 0.72

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

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

ManualLink: 此步骤为手动配置原生依赖项的指导

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony

2.1在工程根目录的 oh-package.json5 添加 overrides 字段

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

2.2引入原生端代码

目前有两种方法:

  1. 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
  2. 直接链接源码。

方法一:通过 har 包引入(推荐)

har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 entry/oh-package.json5,添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-ohos/react-native-localization-settings": "file:../../node_modules/@react-native-ohos/react-native-localization-settings/harmony/localization_settings.har"
  }

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)

2.3在 ArkTs 侧引入 RNLocalizationSettingsPackage

打开 entry/src/main/ets/RNPackagesFactory.ts,添加:

  ...
+ import {RNLocalizationSettingsPackage} from '@react-native-ohos/react-native-localization-settings/ts';

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

2.4配置 CMakeLists 和引入 RNLocalizationSettingsPackage

若使用的是 <= 1.0.2-0.0.1 版本,请跳过本章。

打开 entry/src/main/cpp/CMakeLists.txt,添加:

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/react-native-localization-settings/src/main/cpp" ./localization_settings)

# 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_localization_settings)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp,添加:

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "LocalizationSettingsPackage.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<LocalizationSettingsPackage>(ctx)
    };
}

2.5运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

3.约束与限制

3.1兼容性

要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。

在以下版本验证通过:

  1. RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  2. RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
  3. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  4. RNOH: 0.82.7; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.328 SP26;

4.静态方法

"Platform"列表示该属性在原三方库上支持的平台。

"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。

在设置改变语言之前,确保手机系统添加相应语言

Name Description Type Required Platform HarmonyOS Support
createLanguageDetector(options?: LanguageDetectorOptions) 创建i18next语言检测器 function no iOS/Android yes
getLanguage() 获取当前语言 function no iOS/Android yes
setLanguage(language: string) 设置当前语言 function no iOS/Android yes
getLanguageAsync(fallback?: string) 异步获取当前语言 function no iOS/Android yes

5.遗留问题

6.其他

7.开源协议

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