diff --git a/zh-cn/react-native-default-preference.md b/zh-cn/react-native-default-preference.md new file mode 100644 index 0000000000000000000000000000000000000000..ed237af79d99d4fa9a2f568ed137ebafa2b00878 --- /dev/null +++ b/zh-cn/react-native-default-preference.md @@ -0,0 +1,194 @@ +> 模板版本:v0.2.2 + +

+

react-native-default-preference

+

+

+ + Supported platforms + + + License + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-default-preference) + + + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息:[@react-native-oh-tpl/react-native-default-preference Releases](https://github.com/react-native-oh-library/react-native-default-preference/releases),并下载适用版本的 tgz 包。 + + +进入到工程目录并输入以下命令: + +> [!TIP] # 处替换为 tgz 包的路径 + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-default-preference@file:# +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-default-preference@file:# +``` + + + +下面的代码展示了这个库的基本使用场景: + +> [!WARNING] 使用时 import 的库名不变。 + +```js +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 ( + + + + + ); +}; + +export default App; +``` + +## 使用 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-default-preference": "file:../../node_modules/@react-native-oh-tpl/react-native-default-preference/harmony/react_native_default_preference.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +方法二:直接链接源码 + +> [!TIP] 如需使用直接链接源码,请参考[直接链接源码说明](/zh-cn/link-source-code.md) + + +### 在 ArkTs 侧引入 RNDefaultPreferencePackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`,添加: + +```diff + ... ++ 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) + ]; +} +``` + +### 运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息: +[@react-native-oh-tpl/react-native-default-preference Releases](https://github.com/react-native-oh-library/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)](https://github.com/kevinresol/react-native-default-preference/blob/master/LICENSE) ,请自由地享受和参与开源。 diff --git a/zh-cn/react-native-sensitive-info.md b/zh-cn/react-native-sensitive-info.md index 1b78c7a27a7d27ab8cf24e1606721333d33cf4ea..8f3b165a5767b74356887a4f37bd379fddf60dc4 100644 --- a/zh-cn/react-native-sensitive-info.md +++ b/zh-cn/react-native-sensitive-info.md @@ -172,7 +172,7 @@ ohpm install ```diff ... -+ import { RNSensitiveInfoPackage } from 'react_native_sensitive_info/ts'; ++ import { RNSensitiveInfoPackage } from '@react-native-oh-tpl/react-native-sensitive-info/ts'; @Builder export function createRNPackages(ctx: RNPackageContext): RNPackage[] {