From 34dd55089e3aa0b4da32d364c2134cb599be048a Mon Sep 17 00:00:00 2001
From: ShiLong <n036459@archermind.com>
Date: Tue, 16 Jul 2024 16:57:18 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20[Issues:=20#IADDWP]=20=E6=B7=BB?=
 =?UTF-8?q?=E5=8A=A0react-native-sensitive-info=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-sensitive-info.md | 235 +++++++++++++++++++++++++++
 1 file changed, 235 insertions(+)
 create mode 100644 zh-cn/react-native-sensitive-info.md

diff --git a/zh-cn/react-native-sensitive-info.md b/zh-cn/react-native-sensitive-info.md
new file mode 100644
index 00000000..218ab41c
--- /dev/null
+++ b/zh-cn/react-native-sensitive-info.md
@@ -0,0 +1,235 @@
+模板版本：v0.2.2
+
+<p align="center">
+  <h1 align="center"> <code>react-native-sensitive-info</code> </h1>
+</p>
+
+<p align="center">
+    <a href="https://github.com/mCodex/react-native-sensitive-info">
+        <img src="https://img.shields.io/badge/platforms-android%20|%20ios%2|%20harmony%20-lightgrey.svg" alt="Supported platforms" />
+    </a>
+    <a href="https://github.com/mCodex/react-native-sensitive-info/blob/master/LICENSE">
+        <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License" />
+    </a>
+</p>
+
+
+> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-sensitive-info)
+
+
+## 安装与使用
+
+请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-sensitive-info Releases](https://github.com/react-native-oh-library/react-native-sensitive-info/releases)，并下载适用版本的 tgz 包。
+
+进入到工程目录并输入以下命令：
+
+> [!TIP] # 处替换为 tgz 包的路径
+
+<!-- tabs:start -->
+
+#### **npm**
+
+```bash
+npm install @react-native-oh-tpl/react-native-sensitive-info@file:#
+```
+
+#### **yarn**
+
+```bash
+yarn add @react-native-oh-tpl/react-native-sensitive-info@file:#
+```
+
+<!-- tabs:end -->
+
+下面的代码展示了这个库的基本使用场景：
+
+> [!WARNING] 使用时 import 的库名不变。
+
+```js
+import React, { useCallback, useState } from 'react';
+import { Alert, Button, SafeAreaView, Text } from 'react-native';
+import SInfo from 'react-native-sensitive-info';
+
+const Home: React.FC = () => {
+
+  const [logText, setLogText] = useState('');
+  async function runTest() {
+    const options = {
+      sharedPreferencesName: 'exampleAppTest',
+      keychainService: 'exampleAppTest',
+    };
+    let dbgText = '';
+    dbgText += `setItem(key1, value1): ${await SInfo.setItem(
+      'key1',
+      'value1',
+      options,
+    )}\n`;
+    dbgText += `setItem(key2, value2): ${await SInfo.setItem(
+      'key2',
+      'value2',
+      options,
+    )}\n`;
+    dbgText += `setItem(key3, value3): ${await SInfo.setItem(
+      'key3',
+      'value3',
+      options,
+    )}\n`;
+    dbgText += `getItem(key2): ${await SInfo.getItem('key2', options)}\n`;
+    dbgText += `delItem(key2): ${await SInfo.deleteItem('key2', options)}\n`;
+    dbgText += `getAllItems():\n`;
+    const allItems = await SInfo.getAllItems(options);
+    for (const key in allItems) {
+      dbgText += ` - ${key} : ${allItems[key]}\n`;
+    }
+    setLogText(dbgText);
+  }
+  runTest();
+
+  return (
+    <SafeAreaView style={{ margin: 10 }}>
+      <Button
+        title="Add item using setItem"
+        onPress={handleAddUsingSetItemOnPress}
+      />
+      <Button
+        title="Read data without fingerprint"
+        onPress={handleReadingDataWithoutFingerprint}
+      />
+      <Button
+        title="Add item using TouchID"
+        onPress={handleSetItemUsingTouchIDOnPress}
+      />
+
+      <Button title="Get TouchID Data" onPress={getTouchIDItem} />
+      <Button title="Has TouchID Data" onPress={hasTouchIDItem} />
+
+      <Text>{logText}</Text>
+    </SafeAreaView>
+  );
+};
+export default Home;
+
+```
+
+## 使用 Codegen
+
+本库已经适配了 `Codegen` ，在使用前需要主动执行生成三方库桥接代码，详细请参考[ Codegen 使用文档](/zh-cn/codegen.md)。
+
+## Link
+
+目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。
+
+首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony`
+
+### 在工程根目录的 `oh-package.json` 添加 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-sensitive-info": "file:../../node_modules/@react-native-oh-tpl/react-native-sensitive-info/harmony/date-picker.har"
+  }
+```
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+
+方法二：直接链接源码
+
+
+> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md)
+
+在 ArkTs 侧引入 RNSensitiveInfoPackage 
+打开 entry/src/main/ets/组件RNPackagesFactory.ts，添加：
+
+```diff
+...
++ import { RNSensitiveInfoPackage } from 'react_native_sensitive_info/ts';
+
+@Builder
+export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
+  return [
+    new SamplePackage(ctx),
++   new RNSensitiveInfoPackage(ctx)
+  ];
+}
+
+...
+### 运行
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+​```bash
+cd entry
+ohpm install
+```
+
+然后编译、运行即可。
+
+### 权限要求
+在  YourProject/entry/src/main/module.json5补上配置
+```js
+"requestPermissions": [ { "name": "ohos.permission.ACCESS_BIOMETRIC" }, ]
+```
+
+### 兼容性
+
+要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。
+
+
+请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-sensitive-info Releases](https://github.com/react-native-oh-library/react-native-sensitive-info/releases)
+
+## API
+[!TIP] "Platform"列表示该属性在原三方库上支持的平台。
+
+[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。
+
+| Name        |    Description              | Type     | Required | Platform     | HarmonyOS Support |
+| ---------------- | ------------------------------------------------------------ | -------- | -------- | ------------ | ----------------- |
+| isSensorAvailable()    |  Indicates the overall availability of fingerprint sensor. It will resolve to true or false   |  function | yes      | Android、iOS | yes               |
+| cancelFingerprintAuth ()                   | Canceling fingerprint authentication  | function | yes      | Android、iOS | yes               |
+| hasEnrolledFingerprints ()         | It will return true if detected otherwise returns false  | function | yes      | Android、iOS | yes               |
+| setItem() | Insert new data into the storage. |  function | yes      | Android、iOS | yes               |
+| getItem() | Get an item from storage |  function | yes      | Android、iOS | yes               |
+| getAllItems() | Get all items from storage. |  function | yes      | Android、iOS | yes               |
+| deleteItem() | Delete an item from storage |  function | yes      | Android、iOS | yes               |
+| setInvalidatedByBiometricEnrollment() | Set invalid enrollment by biometrics |  function | yes      | Android | yes               |
+
+## 遗留问题
+
+
+## 其他
+
+## 开源协议
+
+本项目基于 [The MIT License (MIT)](https://github.com/mCodex/react-native-sensitive-info) ，请自由地享受和参与开源。
+
-- 
Gitee