From e9b6e3429c78e77c7ee868bdb83c645c019ecfa1 Mon Sep 17 00:00:00 2001 From: tangshutong Date: Fri, 12 Dec 2025 09:40:41 +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 | 18 ++-- doc/en.md | 283 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/zh-cn.md | 283 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 577 insertions(+), 7 deletions(-) create mode 100644 doc/en.md create mode 100644 doc/zh-cn.md diff --git a/README.md b/README.md index cdf6180..8236838 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -# @react-native-oh-tpl/react-native-mjrefresh -This project is based on [react-native-mjrefresh](https://github.com/react-native-studio/react-native-MJRefresh) -## Documentation -[中文](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-MJRefresh.md) +# 迁移声明 -[English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/en/react-native-MJRefresh.md) +- 本仓库已迁移至 GitCode：[OpenHarmony-SIG/rntpc_react-native-mjrefresh](https://gitcode.com/openharmony-sig/rntpc_react-native-mjrefresh)。 +- 包名已更改为 `@react-native-ohos/react-native-mjrefresh`，支持直接从 npm 下载。 +- 更多详情请查阅新仓库的 README 文件。 +- 本仓库旧版本的文档已归档：[链接](/doc/zh-cn.md) -## License -This library is licensed under [Apache License 2.0](https://github.com/react-native-oh-library/react-native-MJRefresh/blob/sig/LICENSE). \ No newline at end of file +# Migration Announcement + +- This repository has been migrated to GitCode：[OpenHarmony-SIG/rntpc_react-native-mjrefresh](https://gitcode.com/openharmony-sig/rntpc_react-native-mjrefresh) +- The package name has been changed to `@react-native-ohos/react-native-mjrefresh` 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..2b9de99 --- /dev/null +++ b/doc/en.md @@ -0,0 +1,283 @@ +> Template version: v0.2.2 + +

+

react-native-MJRefresh

+

+

+ + Supported platforms + + + License + + +

+ +> [!TIP] [Github address](https://github.com/react-native-oh-library/react-native-MJRefresh) + +## Installation and Usage + +Find the matching version information in the release address of a third-party library: [@react-native-oh-library/react-native-MJRefresh Releases](https://github.com/react-native-oh-library/react-native-MJRefresh/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-mjrefresh +``` + +#### yarn + +```bash +yarn add @react-native-oh-tpl/react-native-mjrefresh +``` + + + +The following code shows the basic use scenario of the repository: + +> [!WARNING] The name of the imported repository remains unchanged. + +```tsx +import React, { Component } from "react"; +import { Text, View } from "react-native"; +import MJRefresh, { ScrollView } from "react-native-mjrefresh"; + +interface State { + text: string, + refreshing: Boolean, +} + +export default class MjRefreshDemo extends Component<{}, State> { + constructor(props: any) { + super(props); + } + + state = { + text: "Pull to Refresh", + refreshing: false + } + _mjrefresh: any = null; + _hw = { + finishRefresh: () => {} + } + + _onRefresh = () => { + setTimeout(() => { + this._hw && this._hw.finishRefresh(); + }, 1000); + } + render() { + return ( + this._mjrefresh = ref} + onRefresh={ + () => { + this.setState({ + text: 'Refreshing' + }) + console.log('onRefresh') + setTimeout(() => { + this._mjrefresh && this._mjrefresh.finishRefresh(); + }, 1000) + } + } + onRefreshIdle={() => console.log('onRefreshIdle')} + onReleaseToRefresh={() => { + this.setState({ + text: 'Release to Refresh' + }) + }} + onPulling={(e: any) => { + console.log('cbdtest onPulling:' + e.nativeEvent.percent) + if (e.nativeEvent.percent < 0.1) { + this.setState({ + text: 'Pull to Refresh' + }) + } + }} + > + + {this.state.text} + + + } + > + {"mjRefresh TEST mjRefresh TEST mjRefresh TEST mjRefresh TEST mjRefresh TEST"} + + ) + }; +}; +``` + +## 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-mjrefresh": "file:../../node_modules/@react-native-oh-tpl/react-native-mjrefresh/harmony/mjrefresh.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 MJRefreshPackge + +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-mjrefresh/src/main/cpp" ./mjrefresh) +# 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_mjrefresh) +# RNOH_END: manual_package_linking_2 +``` + +Open `entry/src/main/cpp/PackageProvider.cpp` and add the following code: + +```diff +#include "RNOH/PackageProvider.h" +#include "SamplePackage.h" ++ #include "MJRefreshPackage.h" + +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), ++ std::make_shared(ctx), + }; +} +``` + +### 4. 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-library/react-native-MJRefresh Releases](https://github.com/react-native-oh-library/react-native-MJRefresh/releases) + +## Properties + +> [!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. + +For more details, see [react-native-MJRefresh](https://github.com/react-native-studio/react-native-MJRefresh) + +| Name | Description | Type | Required | Platform | HarmonyOS Support (ArkTS) |HarmonyOS Support (CAPI) | +| :----------------- | ----------- | -------- | -------- | -------- | ----------------- |----------------- | +| onRefresh | Triggered when refresh | function | No | IOS | yes |yes | +| onRefreshIdle | Triggered when refreshing idle | function | No | IOS | yes |yes | +| onReleaseToRefresh | Triggered when refreshing can be released | function | No | IOS | yes |yes | +| onPulling | Triggered when header is pulled down | function | No | IOS | yes |yes | + +## Static Methods + +> [!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. + +For more details, see [react-native-MJRefresh](https://github.com/react-native-studio/react-native-MJRefresh) + +| Name | Description | Type | Required | Platform | HarmonyOS Support (ArkTS) | HarmonyOS Support (CAPI) | +| :------------ | ----------- | -------- | -------- | -------- | ----------------- |----------------- | +| beginRefresh | Start refreshing | function | No | IOS | yes |yes | +| finishRefresh | End Refresh | function | No | IOS | yes |yes | + +## Others + +## License + +This project is licensed under [Apache License (Apache)](https://github.com/react-native-studio/react-native-MJRefresh/blob/master/LICENSE). diff --git a/doc/zh-cn.md b/doc/zh-cn.md new file mode 100644 index 0000000..1d5f639 --- /dev/null +++ b/doc/zh-cn.md @@ -0,0 +1,283 @@ +> 模板版本：v0.2.2 + +

+

react-native-MJRefresh

+

+

+ + Supported platforms + + + License + + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-MJRefresh) + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-library/react-native-MJRefresh Releases](https://github.com/react-native-oh-library/react-native-MJRefresh/releases) 。对于未发布到npm的旧版本，请参考[安装指南](/zh-cn/tgz-usage.md)安装tgz包。 + +进入到工程目录并输入以下命令： + + + +#### npm + +```bash +npm install @react-native-oh-tpl/react-native-mjrefresh +``` + +#### yarn + +```bash +yarn add @react-native-oh-tpl/react-native-mjrefresh +``` + + + +下面的代码展示了这个库的基本使用场景： + +> [!WARNING] 使用时 import 的库名不变。 + +```tsx +import React, { Component } from "react"; +import { Text, View } from "react-native"; +import MJRefresh, { ScrollView } from "react-native-mjrefresh"; + +interface State { + text: string, + refreshing: Boolean, +} + +export default class MjRefreshDemo extends Component<{}, State> { + constructor(props: any) { + super(props); + } + + state = { + text: "下拉刷新", + refreshing: false + } + _mjrefresh: any = null; + _hw = { + finishRefresh: () => {} + } + + _onRefresh = () => { + setTimeout(() => { + this._hw && this._hw.finishRefresh(); + }, 1000); + } + render() { + return ( + this._mjrefresh = ref} + onRefresh={ + () => { + this.setState({ + text: '正在刷新' + }) + console.log('onRefresh') + setTimeout(() => { + this._mjrefresh && this._mjrefresh.finishRefresh(); + }, 1000) + } + } + onRefreshIdle={() => console.log('onRefreshIdle')} + onReleaseToRefresh={() => { + this.setState({ + text: '释放刷新' + }) + }} + onPulling={(e: any) => { + console.log('cbdtest onPulling:' + e.nativeEvent.percent) + if (e.nativeEvent.percent < 0.1) { + this.setState({ + text: '下拉刷新' + }) + } + }} + > + + {this.state.text} + + + } + > + {"mjRefresh TEST mjRefresh TEST mjRefresh TEST mjRefresh TEST mjRefresh TEST"} + + ) + }; +}; +``` + +## Link + +目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony` + +### 在工程根目录的 `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-mjrefresh": "file:../../node_modules/@react-native-oh-tpl/react-native-mjrefresh/harmony/mjrefresh.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +方法二：直接链接源码 + +> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md) + +### 3.配置 CMakeLists 和引入 MJRefreshPackge + +打开 `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-mjrefresh/src/main/cpp" ./mjrefresh) +# 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_mjrefresh) +# RNOH_END: manual_package_linking_2 +``` + +打开 `entry/src/main/cpp/PackageProvider.cpp`，添加： + +```diff +#include "RNOH/PackageProvider.h" +#include "SamplePackage.h" ++ #include "MJRefreshPackage.h" + +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), ++ std::make_shared(ctx), + }; +} +``` + +### 4.运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-library/react-native-MJRefresh Releases](https://github.com/react-native-oh-library/react-native-MJRefresh/releases) + +## 属性 + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +详情请见[react-native-MJRefresh](https://github.com/react-native-studio/react-native-MJRefresh) + +| Name | Description | Type | Required | Platform | HarmonyOS Support (ArkTS) |HarmonyOS Support (CAPI) | +| :----------------- | ----------- | -------- | -------- | -------- | ----------------- |----------------- | +| onRefresh | 刷新时触发 | function | No | IOS | yes |yes | +| onRefreshIdle | 刷新闲置时触发 | function | No | IOS | yes |yes | +| onReleaseToRefresh | 可释放刷新时触发 | function | No | IOS | yes |yes | +| onPulling | header下拉过程中触发 | function | No | IOS | yes |yes | + +## 静态方法 + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +详情请见[react-native-MJRefresh](https://github.com/react-native-studio/react-native-MJRefresh) + +| Name | Description | Type | Required | Platform | HarmonyOS Support (ArkTS) | HarmonyOS Support (CAPI) | +| :------------ | ----------- | -------- | -------- | -------- | ----------------- |----------------- | +| beginRefresh | 开始刷新 | function | No | IOS | yes |yes | +| finishRefresh | 结束刷新 | function | No | IOS | yes |yes | + +## 其他 + +## 开源协议 + +本项目基于 [Apache License (Apache)](https://github.com/react-native-studio/react-native-MJRefresh/blob/master/LICENSE) ，请自由地享受和参与开源。