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

+

react-native-bootsplash

+

+

+ + Supported platforms + + + License + + +

+ + +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-bootsplash) + +如: + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息:[@react-native-oh-tpl/react-native-bootsplash Releases](https://github.com/<仓库地址>/releases),并下载适用版本的 tgz 包。 + +如:请到三方库的 Releases 发布地址查看配套的版本信息:[@react-native-oh-tpl/react-native-bootsplash Releases](https://github.com/react-native-oh-library/react-native-safe-area-context/releases),并下载适用版本的 tgz 包。(删除) + +进入到工程目录并输入以下命令: + +> [!TIP] # 处替换为 tgz 包的路径 + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-bootsplash@file:# +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-bootsplash@file:# +``` + + + +下面的代码展示了这个库的基本使用场景: + +> [!WARNING] 使用时 import 的库名不变。 + +```js +import { useState , useEffect} from "react"; +import { Animated, View, Text, Dimensions, Platform, StatusBar, StyleSheet } from "react-native"; +import BootSplash from "react-native-bootsplash"; + +const styles = StyleSheet.create({ + container: { + flex: 1, + justifyContent: "center", + alignItems: "center", + backgroundColor: "#F5FCFF", + }, + text: { + fontSize: 30, + fontWeight: "700", + margin: 20, + lineHeight: 30, + color: "#333", + textAlign: "center", + }, +}); + +type Props = { + onAnimationEnd: () => void; +}; + +export const AnimatedBootSplash = ({ onAnimationEnd }: Props) => { + const [opacity] = useState(() => new Animated.Value(1)); + const [translateY] = useState(() => new Animated.Value(0)); + + const { container, logo /*, brand */ } = BootSplash.useHideAnimation({ + manifest: require("../assets/bootsplash_manifest.json"), + logo: require("../assets/bootsplash_logo.png"), + statusBarTranslucent: true, + navigationBarTranslucent: false, + + animate: () => { + const { height } = Dimensions.get("window"); + Animated.stagger(250, [ + Animated.spring(translateY, { + useNativeDriver: true, + toValue: -50, + }), + Animated.spring(translateY, { + useNativeDriver: true, + toValue: height, + }), + ]).start(); + Animated.timing(opacity, { + useNativeDriver: true, + toValue: 0, + duration: 150, + delay: 350, + }).start(() => { + onAnimationEnd(); + }); + }, + }); + + return ( + + + {/* */} + + ); +}; + +const App = () => { + const [visible, setVisible] = useState(true); + + useEffect(() => { + // set transparent status bar + StatusBar.setBarStyle("dark-content"); + if (Platform.OS !== "android") { + StatusBar.setBackgroundColor("transparent"); + StatusBar.setTranslucent(true); + } + }, []); + + return ( + <> + + Hello World + {visible && ( + { + BootSplash.isVisible(); + console.log("--------++++AnimationEnd") + setVisible(false); + }} + /> + )} + + + ); +}; + +export default App; +``` + +## 使用 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-bootsplash": "file:../../node_modules/@react-native-oh-tpl/react-native-bootsplash/harmony/boot_splash.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +方法二:直接链接源码 + +> [!TIP] 如需使用直接链接源码,请参考[直接链接源码说明](/zh-cn/link-source-code.md) + +### 在 ArkTs 侧引入 RNBootSplashPackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`,添加: + +```diff +... ++ import {RNBootSplashPackage} from '@react-native-oh-tpl/react-native-bootsplash/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new RNBootSplashPackage(ctx) + ]; +} +``` + +### 运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +本文档内容基于以下版本验证通过: + +1. RNOH: 0.72.26; SDK: HarmonyOS NEXT Developer Beta1; IDE: DevEco Studio 5.0.3.300; ROM: 3.0.0.25; + +## API + +> [!tip] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---------------- | ------------ | -------- | -------- | ------------ | ----------------- | +| getConstants | 获取默认配置 | function | yes | Android、IOS | yes | +| hide | 隐藏 | function | yes | Android、IOS | yes | +| isVisible | 是否可见 | function | yes | Android、IOS | yes | +| useHideAnimation | 使用隐藏动画 | function | yes | Android、IOS | yes | + +## 遗留问题 + +## 其他 + +## 开源协议 + +本项目基于 [The MIT License (MIT)](https://github.com/zoontek/react-native-bootsplash/blob/expo-plugin/LICENSE.md) ,请自由地享受和参与开源。 + + \ No newline at end of file