Skip to content

Latest commit

 

History

History
228 lines (158 loc) · 7.18 KB

react-native-spinkit.md

File metadata and controls

228 lines (158 loc) · 7.18 KB

模板版本：v0.2.2

react-native-spinkit

Supported platforms License

[!TIP] Github 地址

安装与使用

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

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

npm

npm install @react-native-oh-tpl/react-native-spinkit

yarn

yarn add @react-native-oh-tpl/react-native-spinkit

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

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

import React from 'react';
import Spinkit from 'react-native-spinkit';

const SpinKitDemo: React.FC = (): JSX.Element => {
    return (
    	<Spinkit 
        	type='9CubeGrid' 
        	color='#e74032' 
        	size={60} 
			style={{ backgroundColor: '#fcc424' }} 
            isVisible={true} 
		/>
    )
};

export default SpinKit;

使用 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-spinkit": "file:../../node_modules/@react-native-oh-tpl/react-native-spinkit/harmony/spinKit.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

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

3.在 ArkTs 侧引入 SpinKitView 组件

找到 function buildCustomComponent()，一般位于 entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets，添加：

  ...
+ import { SpinKitView } from "@react-native-oh-tpl/react-native-spinkit"

@Builder
export function buildCustomRNComponent(ctx: ComponentBuilderContext) {
  ...
+ if (ctx.componentName === SpinKitView.NAME) {
+   SpinKitView({
+        ctx: ctx.rnComponentContext,
+        tag: ctx.tag
+   })
+ }
 ...
}

[!TIP] 本库使用了混合方案，需要添加组件名。

在entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets 找到常量 arkTsComponentNames 在其数组里添加组件名

const arkTsComponentNames: Array<string> = [
  SampleView.NAME,
  GeneratedSampleView.NAME,
  PropsDisplayer.NAME,
+ SpinKitView.NAME
  ];

4.在 ArkTs 侧引入 SpinKitPackage Package

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

  ...
+ import { RNSpinKitPackage } from '@react-native-oh-tpl/react-native-spinkit/ts';

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

5.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

兼容性

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

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

属性

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

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

SpinKit：加载动画渲染组件，接收所有 View 的props。

props Description Type Required Platform HarmonyOS Support
type Types of Load Animations string No All Yes
type: Plane One Direction Flip Loading Animation string No All Yes
type: CircleFlip A circle flips to load animation string No All Yes
type: Bounce A circular nested loading animation string No All Yes
type: Wave Five-bar group loading animation string No All Yes
type: WanderingCubes Two squares skip loading animation string No All Yes
type: Pulse A circular diffusion loading animation string No All Yes
type: ChansingDots Two Circles Bounce Loading Animation string No All Yes
type: ThreeBounce Three circles display the loading animation in sequence. string No All Yes
type: Circle Multiple circular circular motion loading animation string No All Yes
type: 9CubeGrid The nine squares display the loading animation in sequence string No All Yes
type: WordPress Round wheel inline hollow circle rotating Loading animation string No IOS Yes
type: FadingCircle Multiple square circular motion loading animation string No All Yes
type: FadingCircleAlt Multiple circular circular motion loading animation string No All Yes
type: Arc Rotating ring with notch loading animation string No IOS Yes
type: ArcAlt Circular progress bar style loading animation string No IOS Yes
isVisible Visibility of the spinner boolean No All Yes
color Color of the spinner string No All Yes
size Visibility of the spinner number No All Yes

遗留问题

其他

开源协议

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