Skip to content

Latest commit

 

History

History
193 lines (129 loc) · 5.98 KB

react-native-default-preference.md

File metadata and controls

193 lines (129 loc) · 5.98 KB

模板版本：v0.2.2

react-native-default-preference

Supported platforms License

[!TIP] Github 地址

安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：@react-native-oh-tpl/react-native-default-preference Releases 。对于未发布到npm的旧版本，请参考安装指南安装tgz包。

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

npm

npm install @react-native-oh-tpl/react-native-default-preference

yarn

yarn add @react-native-oh-tpl/react-native-default-preference

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

[!WARNING] 使用时 import 的库名不变。

import React from "react";
import { Text, View } from "react-native";
import DefaultPreference from 'react-native-default-preference';

const App = () => {
    const handleSetItem = useCallback((key: string, value:  string) => {
        RNDefaultPreference.set(key, value)
    }, []);

    const handleGetItem = useCallback((key: string) => {
        RNDefaultPreference?.get(key).then(res => {
            console.log(res)
        });
    }, []);
  return (
      <View>
        <Button onPress={async () => { handleSetItem('key1', 'value1') }} title={'Add item using setItem'}></Button>
        <Button onPress={async () => { handleGetItem('key1') }} title={'Add item using setItem'}></Button>
     </View>
  );
};

export default App;

使用 Codegen

本库已经适配了 Codegen ，在使用前需要主动执行生成三方库桥接代码，详细请参考 Codegen 使用文档。

Link

目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。

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

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

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

2.引入原生端代码

目前有两种方法：

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

方法一：通过 har 包引入（推荐）

[!TIP] har 包位于三方库安装路径的 harmony 文件夹下。

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

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-oh-tpl/react-native-default-preference": "file:../../node_modules/@react-native-oh-tpl/react-native-default-preference/harmony/react_native_default_preference.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 如需使用直接链接源码，请参考直接链接源码说明

3.在 ArkTs 侧引入 RNDefaultPreferencePackage

打开 entry/src/main/ets/RNPackagesFactory.ts，添加：

...

+ import { RNDefaultPreferencePackage } from '@react-native-oh-tpl/react-native-default-preference/ts';

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

4.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

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

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息： @react-native-oh-tpl/react-native-default-preference Releases

API

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

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

Name Description Type Required Platform HarmonyOS Support
get Take out key-value pairs function yes Android、iOS yes
set Set key-value pairs function yes Android、iOS yes
clear Clear key-value pairs function yes Android、iOS yes
getMultiple Take out multiple key-value pairs function yes Android、iOS yes
setMultiple Set multiple key-value pairs function yes Android、iOS yes
clearMultiple Clear multiple key-value pairs function yes Android、iOS yes
getAll Take out all key-value pairs function no Android、iOS yes
clearAll Clear all key-value pairs function no Android、iOS yes
getName Gets the name of the Preferences instance. function no Android、iOS yes
setName Sets the name of the Preferences instance. function yes Android、iOS yes

遗留问题

其他

开源协议

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