From 5ba5bdd19145ee9a4c21923a77d198e941c91965 Mon Sep 17 00:00:00 2001 From: tangshutong Date: Wed, 3 Dec 2025 21:22:57 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E8=BF=81=E7=A7=BB?= =?UTF-8?q?=E5=A3=B0=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: tangshutong --- README.md | 21 ++-- doc/en.md | 324 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/zh-cn.md | 324 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 658 insertions(+), 11 deletions(-) create mode 100644 doc/en.md create mode 100644 doc/zh-cn.md diff --git a/README.md b/README.md index b75f010..6dabba2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ -# @react-native-oh-tpl/react-native-bindingx +# 迁移声明 -This project is based on [alibaba/bindingx](https://github.com/alibaba/bindingx) +- 本仓库已迁移至 GitCode：[OpenHarmony-SIG/rntpc_react-native-bindingx](https://gitcode.com/openharmony-sig/rntpc_react-native-bindingx)。 +- 包名已更改为 `@react-native-ohos/react-native-bindingx`，支持直接从 npm 下载。 +- 更多详情请查阅新仓库的 README 文件。 +- 本仓库旧版本的文档已归档：[链接](/doc/zh-cn.md) -## Documentation +# Migration Announcement -[中文](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-bindingx.md) - -[English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/en/react-native-bindingx.md) - - -## License - -This library is licensed under [The MIT License (MIT)](https://github.com/react-native-oh-library/react-native-bindingx/blob/sig/LICENSE.md). +- This repository has been migrated to GitCode：[OpenHarmony-SIG/rntpc_react-native-bindingx](https://gitcode.com/openharmony-sig/rntpc_react-native-bindingx) +- The package name has been changed to `@react-native-ohos/react-native-bindingx` and is now available for direct download from npm. +- For more details, please refer to the README in the new repository. +- Archived documentation for versions in this repository can be found here: [Link](/doc/en.md) diff --git a/doc/en.md b/doc/en.md new file mode 100644 index 0000000..e30636e --- /dev/null +++ b/doc/en.md @@ -0,0 +1,324 @@ +> Template version: v0.2.2 + +

+

react-native-bindingx

+

+

+ + Supported platforms + + + License + +

+ +> [!TIP] [Github address](https://github.com/react-native-oh-library/react-native-bindingx) + + +## Installation and Usage + +Find the matching version information in the release address of a third-party library: [@react-native-oh-tpl/react-native-bindingx Releases](https://github.com/react-native-oh-library/react-native-bindingx/releases).For older versions that are not published to npm, please refer to the [installation guide](/en/tgz-usage-en.md) to install the tgz package. + +Go to the project directory and execute the following instruction: + + + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-bindingx +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-bindingx +``` + + + +The following code shows the basic use scenario of the repository: + +> [!WARNING] The name of the imported repository remains unchanged. + +```js +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 { + + _panResponder = PanResponder.create({ + onStartShouldSetPanResponder: (evt, gestureState) => true, + onPanResponderGrant: (evt, gestureState) => { + this.onBind(); + } + }); + + _x = 0; + _y = 0; + + componentDidMount() { + let anchor = findNodeHandle(this.refs._anchor); + 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.refs._anchor); + 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 ( + + + + + ); + } +} + +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 + +Currently, HarmonyOS does not support AutoLink. Therefore, you need to manually configure the linking. + +Open the `harmony` directory of the HarmonyOS project in DevEco Studio. + +### 1. Adding the overrides Field to oh-package.json5 File in the Root Directory of the Project + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 2. Introducing Native Code + +Currently, two methods are available: + + +Method 1 (recommended): Use the HAR file. + +> [!TIP] The HAR file is stored in the `harmony` directory in the installation path of the third-party library. + +Open `entry/oh-package.json5` file and add the following dependencies: + +```json +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-bindingx": "file:../../node_modules/@react-native-oh-tpl/react-native-bindingx/harmony/bindingx.har" + } +``` + +Click the `sync` button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Method 2: Directly link to the source code. + +> [!TIP] For details, see [Directly Linking Source Code](/en/link-source-code.md). + +### 3. Configuring CMakeLists and Introducing ReactBindingXPackge + +Open `entry/src/main/cpp/CMakeLists.txt` and add the following code: + +```diff +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-tpl/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 +``` + +Open `entry/src/main/cpp/PackageProvider.cpp` and add the following code: + +```diff +#include "RNOH/PackageProvider.h" +#include "generated/RNOHGeneratedPackage.h" +#include "SamplePackage.h" ++ #include "ReactBindingXPackage.h" + +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), + std::make_shared(ctx), ++ std::make_shared(ctx), + }; +} +... +``` + + +### 4. Introducing ReactBindingXPackage to ArkTS + +Open the `entry/src/main/ets/RNPackagesFactory.ts` file and add the following code: + +```diff + ... ++ import {ReactBindingXPackage} from '@react-native-oh-tpl/react-native-bindingx/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new ReactBindingXPackage(ctx) + ]; +} +``` + +### 5. Running + +Click the `sync` button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Then build and run the code. + +## Constraints + +### Compatibility + +To use this repository, you need to use the correct React-Native and RNOH versions. In addition, you need to use DevEco Studio and the ROM on your phone. + +Check the release version information in the release address of the third-party library:[@react-native-oh-tpl/react-native-bindingx Releases](https://github.com/react-native-oh-library/react-native-bindingx/releases) + +## API + +> [!TIP] The **Platform** column indicates the platform where the properties are supported in the original third-party library. + +> [!TIP] If the value of **HarmonyOS Support** is **yes**, it means that the HarmonyOS platform supports this property; **no** means the opposite; **partially** means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android. + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------- | ----------------| ------------------ | +| bind | Build a specific event type of binding instance. When the event is triggered, corresponding expression will be executed and touch off transform in specified element. | string | no | iOS/Android | yes | +| unbind | unbind specified binding instance. | void | no | iOS/Android | yes | +| unbindAll | unbind all binding instance | void | no | iOS/Android | yes | +| prepare | launch bind. This method is only useful for pan type binding. | void | no | iOS/Android | yes | +| getComputedStyle | get styles of specified view. | Promise | no | iOS/Android | yes | + +## Known Issues + +## Others + +## License + +This project is licensed under [Apache License2.0](https://github.com/alibaba/bindingx/blob/master/LICENSE.md). diff --git a/doc/zh-cn.md b/doc/zh-cn.md new file mode 100644 index 0000000..bb9dc17 --- /dev/null +++ b/doc/zh-cn.md @@ -0,0 +1,324 @@ +> 模板版本：v0.2.2 + +

+

react-native-bindingx

+

+

+ + Supported platforms + + + License + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-bindingx) + + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-bindingx Releases](https://github.com/react-native-oh-library/react-native-bindingx/releases) 。对于未发布到npm的旧版本，请参考[安装指南](/zh-cn/tgz-usage.md)安装tgz包。 + +进入到工程目录并输入以下命令： + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-bindingx +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-bindingx +``` + + + +下面的代码展示了这个库的基本使用场景： + +> [!WARNING] 使用时 import 的库名不变。 + +```js +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 { + + _panResponder = PanResponder.create({ + onStartShouldSetPanResponder: (evt, gestureState) => true, + onPanResponderGrant: (evt, gestureState) => { + this.onBind(); + } + }); + + _x = 0; + _y = 0; + + componentDidMount() { + let anchor = findNodeHandle(this.refs._anchor); + 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.refs._anchor); + 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 ( + + + + + ); + } +} + +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 + +目前HarmonyOS暂不支持 AutoLink，所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的HarmonyOS工程 `harmony` + +### 1.在工程根目录的 `oh-package.json5` 添加 overrides 字段 + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 2.引入原生端代码 + +目前有两种方法： + +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-bindingx": "file:../../node_modules/@react-native-oh-tpl/react-native-bindingx/harmony/bindingx.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +方法二：直接链接源码 + +> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md) + +### 3.配置 CMakeLists 和引入 ReactBindingXPackge + +打开 `entry/src/main/cpp/CMakeLists.txt`，添加： + +```diff +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-tpl/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`，添加： + +```diff +#include "RNOH/PackageProvider.h" +#include "generated/RNOHGeneratedPackage.h" +#include "SamplePackage.h" ++ #include "ReactBindingXPackage.h" + +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), + std::make_shared(ctx), ++ std::make_shared(ctx), + }; +} +... +``` + + +### 4.在 ArkTs 侧引入 ReactBindingXPackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加： + +```diff + ... ++ import {ReactBindingXPackage} from '@react-native-oh-tpl/react-native-bindingx/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new ReactBindingXPackage(ctx) + ]; +} +``` + +### 5.运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-bindingx Releases](https://github.com/react-native-oh-library/react-native-bindingx/releases) + +## API + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |----------| ----------------| ------------------ | +| bind | Build a specific event type of binding instance. When the event is triggered, corresponding expression will be executed and touch off transform in specified element. | string | no | iOS/Android | yes | +| unbind | unbind specified binding instance. | void | no | iOS/Android | yes | +| unbindAll | unbind all binding instance | void | no | iOS/Android | yes | +| prepare | launch bind. This method is only useful for pan type binding. | void | no | iOS/Android | yes | +| getComputedStyle | get styles of specified view. | Promise | no | iOS/Android | yes | + +## 遗留问题 + +## 其他 + +## 开源协议 + +本项目基于 [Apache License2.0](https://github.com/alibaba/bindingx/blob/master/LICENSE.md) ，请自由地享受和参与开源。