From c7234261b2163539018efccc9df26b2c4fffdd4e Mon Sep 17 00:00:00 2001
From: ding_chengjie <dingchenjie1@h-partners.com>
Date: Mon, 13 May 2024 11:04:38 +0800
Subject: [PATCH] =?UTF-8?q?[Issues:=20#I9OQ2G]=20=E6=B7=BB=E5=8A=A0react-n?=
 =?UTF-8?q?ative-toast=E6=8C=87=E5=AF=BC=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-toast.md | 230 ++++++++++++++++++++++++++++++++++++
 1 file changed, 230 insertions(+)
 create mode 100644 zh-cn/react-native-toast.md

diff --git a/zh-cn/react-native-toast.md b/zh-cn/react-native-toast.md
new file mode 100644
index 00000000..c2b930d4
--- /dev/null
+++ b/zh-cn/react-native-toast.md
@@ -0,0 +1,230 @@
+<p align="center">
+  <h1 align="center"> <code>react-native-toast</code> </h1>
+</p>
+<p align="center">
+    <a href="https://github.com/<原库源码仓地址>">
+        <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/<原库源码仓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-toast)
+
+
+## 安装与使用
+
+请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-toast Releases](https://github.com/react-native-oh-library/react-native-toast/releases)，并下载适用版本的 tgz 包。
+
+进入到工程目录并输入以下命令：
+
+> [!TIP] # 处替换为 tgz 包的路径
+
+<!-- tabs:start -->
+
+#### **npm**
+
+```bash
+npm install @react-native-oh-tpl/react-native-toast@file:#
+```
+
+#### **yarn**
+
+```bash
+yarn add @react-native-oh-tpl/react-native-toast@file:#
+```
+
+<!-- tabs:end -->
+
+下面的代码展示了这个库的基本使用场景：
+
+> [!WARNING] 使用时 import 的库名不变。
+
+```js
+import React, { Component } from 'react';
+import { Text, View, Button } from 'react-native';
+import Toast from 'react-native-toast';
+
+function ToastMasterDemo(){
+    return (
+      <View style={{ flex: 2, justifyContent: 'center', alignItems: 'center' }}>
+        <Text>Tosat !</Text>
+        <Button
+          title={'show toast'}
+          onPress={() => {
+            Toast.show('This is a toast.');
+          }}
+        />
+        <Button
+          title={'short top toast'}
+          onPress={() => {
+            Toast.showShortTop('This is a top toast.');
+          }}
+        />
+        <Button
+          title={'short center toast'}
+          onPress={() => {
+            Toast.showShortCenter('This is a center toast.');
+          }}
+        />
+        <Button
+          title={'short bottom toast'}
+          onPress={() => {
+            Toast.showShortBottom('This is a bottom toast.');
+          }}
+        />
+        <Button
+          title={'long top toast'}
+          onPress={() => {
+            Toast.showLongTop('This is a long top toast.');
+          }}
+        />
+        <Button
+          title={'long center toast'}
+          onPress={() => {
+            Toast.showLongCenter('This is a long center toast.');
+          }}
+        />
+        <Button
+          title={'long bottom toast'}
+          onPress={() => {
+            Toast.showLongBottom('This is a long bottom toast.');
+          }}
+        />
+		<Button
+          title={'hide'}
+          onPress={() => {
+            Toast.hide();
+          }}
+        />
+      </View>
+    );
+}
+
+export default ToastMasterDemo;
+
+```
+
+## Link
+
+目前鸿蒙暂不支持 AutoLink，所以 Link 步骤需要手动配置。
+
+首先需要使用 DevEco Studio 打开项目里的鸿蒙工程 `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-toast": "file:../../node_modules/@react-native-oh-tpl/react-native-toast/harmony/rn_toast.har"
+  }
+```
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+
+方法二：直接链接源码
+
+> [!TIP] 源码位于三方库安装路径的 `harmony` 文件夹下。
+
+打开 `entry/oh-package.json5`，添加以下依赖
+
+```json
+"dependencies": {
+    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
+    "@react-native-oh-tpl/react-native-toast": "file:../../node_modules/@react-native-oh-tpl/react-native-toast/harmony/rn_toast"
+  }
+```
+
+打开终端，执行：
+
+```bash
+cd entry
+ohpm install --no-link
+```
+
+### 在 ArkTs 侧引入 xxx Package
+
+打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加：
+
+```diff
+...
++ import {SafeAreaViewPackage} from '@react-native-oh-tpl/react-native-toast/ts';
+
+export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
+  return [
+    new SamplePackage(ctx),
++   new ToastPackage(ctx)
+  ];
+}
+```
+
+### 运行
+
+点击右上角的 `sync` 按钮
+
+或者在终端执行：
+
+```bash
+cd entry
+ohpm install
+```
+
+然后编译、运行即可。
+
+## 约束与限制
+
+### 兼容性
+
+要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。
+
+请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-toast Releases](https://github.com/react-native-oh-library/react-native-toast/releases)
+
+## API（TurboModules）
+
+> [!tip] "Platform"列表示该属性在原三方库上支持的平台。
+
+> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。
+
+| Name | Description | Type | Required | Platform | HarmonyOS Support  |
+| ---- | ----------- | ---- | -------- | -------- | ------------------ |
+| show()  | Displays the location of the toast, its duration, the content of the message | function  | (yes) | ios      | (yes) |
+| hide()  | Hide the toast that is being displayed         | function  | (yes) | android      | (no) |
+
+## 遗留问题
+
+## 其他
+
+## 开源协议
+
+本项目基于 [The MIT License MIT](https://github.com/react-native-oh-library/react-native-toast/blob/sig/LICENSE)，请自由地享受和参与开源。
-- 
Gitee