模板版本:v0.4.0
react-native-bindingx
本项目基于 react-native-bindingx 开发。
该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-bindingx 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-bindingx | ~1.2.0 | GitCode Releases | 0.82 | 是 | API12+ | 1.0.3 | Npm Address |
| @react-native-ohos/react-native-bindingx | ~1.1.0 | GitCode Releases | 0.77 | 否 | API12+ | 1.0.3 | Npm Address |
| @react-native-ohos/react-native-bindingx | ~1.0.4 | GitCode Releases | 0.72 | 是 | API12+ | 1.0.3 | Npm Address |
| @react-native-oh-tpl/react-native-bindingx | <=1.0.3-0.0.4@deprecated | GitHub Releases | 0.72 | 否 | API12+ | 1.0.3 | Npm Address |
安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-bindingx
yarn
yarn add @react-native-ohos/react-native-bindingx
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import React, {Component} from 'react';
import {
StyleSheet,
View,
Text,
findNodeHandle,
TouchableHighlight,
PanResponder
} from 'react-native';
import bindingx from 'react-native-bindingx';
export default class App extends Component {
constructor(props) {
super(props);
this._anchorRef = React.createRef();
}
_panResponder = PanResponder.create({
onStartShouldSetPanResponder: (evt, gestureState) => true,
onPanResponderGrant: (evt, gestureState) => {
this.onBind();
}
});
_x = 0;
_y = 0;
componentDidMount() {
let anchor = findNodeHandle(this._anchorRef.current);
bindingx.prepare({
eventType: 'pan',
anchor: anchor
});
}
onPanEnd = (e) => {
if (e.state === 'end') {
this._x += e.deltaX;
this._y += e.deltaY;
}
}
onBind() {
let expression_x_origin = "x+" + this._x;
let expression_y_origin = "y+" + this._y;
let anchor = findNodeHandle(this._anchorRef.current);
let token = bindingx.bind({
eventType: 'pan',
anchor: anchor,
props: [
{
element: anchor,
property: 'transform.translateX',
expression: expression_x_origin
},
{
element: anchor,
property: 'transform.translateY',
expression: expression_y_origin
}
]
},this.onPanEnd);
}
render() {
return (
<View style={styles.container}>
<View
ref={this._anchorRef}
style={styles.anchor}
{...this._panResponder.panHandlers}
/>
</View>
);
}
}
const styles = StyleSheet.create({
container: {
flex: 1,
backgroundColor: '#F5FCFF',
},
instructions: {
textAlign: 'center',
color: '#333333',
marginBottom: 10,
},
text: {
textAlign: 'center',
color: '#ffffff',
},
wrapper: {
backgroundColor: '#0000ff',
height: 48,
alignItems: 'center',
justifyContent: 'center'
},
margin: {
marginTop: 20
},
anchor: {
width: 80,
height: 80,
backgroundColor: '#ff0000',
marginTop: 48
}
});
Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~1.2.0 | Yes | 0.82 |
| ~1.1.0 | No | 0.77 |
| ~1.0.4 | Yes | 0.72 |
| <= 1.0.3-0.0.4@deprecated | No | 0.72 |
使用AutoLink的工程需要根据该文档配置,Autolink框架指导文档:https://gitcode.com/openharmony-sig/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md
如您使用的版本支持 Autolink,并且工程已接入 Autolink,可跳过ManualLink配置。
ManualLink: 此步骤为手动配置原生依赖项的指导
首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony。
1.Overrides RN SDK
为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。
关于该字段的作用请阅读官方说明:
{
"overrides": {
"@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // Path to local har package
// "@rnoh/react-native-openharmony" : "./react_native_openharmony" // Point to source code path
}
}
2.引入原生端代码
目前有两种方法:
- 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
- 直接链接源码。
方法一:通过 har 包引入(推荐)
har 包位于三方库安装路径的 `harmony` 文件夹下。
打开 entry/oh-package.json5,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@react-native-ohos/react-native-bindingx": "file:../../node_modules/@react-native-ohos/react-native-bindingx/harmony/bindingx.har"
}
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考直接链接源码说明
3.配置 CMakeLists 和引入 ReactBindingXPackge
若使用的是 <= 1.0.3-0.0.4 版本,请跳过本章。
打开 entry/src/main/cpp/CMakeLists.txt,添加:
project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(CMAKE_SKIP_BUILD_RPATH TRUE)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
set(NODE_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../node_modules")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")
set(LOG_VERBOSITY_LEVEL 1)
set(CMAKE_ASM_FLAGS "-Wno-error=unused-command-line-argument -Qunused-arguments")
set(CMAKE_CXX_FLAGS "-fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -s -fPIE -pie")
set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use
add_compile_definitions(WITH_HITRACE_SYSTRACE)
add_subdirectory("${RNOH_CPP_DIR}" ./rn)
# RNOH_BEGIN: manual_package_linking_1
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@react-native-oh-ohos/react-native-bindingx/src/main/cpp" ./bindingx)
# RNOH_END: manual_package_linking_1
file(GLOB GENERATED_CPP_FILES "./generated/*.cpp")
add_library(rnoh_app SHARED
${GENERATED_CPP_FILES}
"./PackageProvider.cpp"
"${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)
target_link_libraries(rnoh_app PUBLIC rnoh)
# RNOH_BEGIN: manual_package_linking_2
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_bindingx)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "ReactBindingXPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<RNOHGeneratedPackage>(ctx),
std::make_shared<SamplePackage>(ctx),
+ std::make_shared<ReactBindingXPackage>(ctx),
};
}
...
4.在 ArkTs 侧引入 ReactBindingXPackage
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
...
+ import {ReactBindingXPackage} from '@react-native-ohos/react-native-bindingx/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new ReactBindingXPackage(ctx)
];
}
运行
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
然后编译、运行即可。
约束与限制
兼容性
要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。
在以下版本验证通过:
- RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
- RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH:0.82.1; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.120 SP7;
API
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| bind | 构建绑定实例的特定事件类型。当事件被触发时,将执行相应的表达式,并在指定的元素中触发转换. | string | No | iOS/Android | Yes |
| unbind | 取消指定绑定实例. | void | No | iOS/Android | Yes |
| unbindAll | 取消所有绑定实例 | void | No | iOS/Android | Yes |
| prepare | 启动绑定。此方法仅对pan类型绑定有用. | void | No | iOS/Android | Yes |
| getComputedStyle | 获取指定视图的样式. | Promise | No | iOS/Android | Yes |
遗留问题
其他
开源协议
本项目基于 Apache License2.0 ,请自由地享受和参与开源。