模板版本:v0.4.0

pull-to-refresh

本项目基于 pull-to-refresh 开发。

请到三方库的 Releases 发布地址查看配套的版本信息:

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/pull-to-refresh ~1.0.0 (开发中) Github Release 0.82 API12+ 1.1.6 Npm Address
@react-native-ohos/pull-to-refresh ~0.28.1 Github Release 0.77 API12+ 0.27.0 Npm Address
@react-native-ohos/pull-to-refresh ~0.27.1 Github Release 0.72 API12+ 0.27.0 Npm Address

1. 安装与使用

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

npm

npm install @react-native-ohos/pull-to-refresh@xxx

yarn

yarn add @react-native-ohos/pull-to-refresh@xxx

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

import React, {useRef, useState} from 'react';
import {PullToRefresh} from '@sdcx/pull-to-refresh';
import {FlatListPage, useDemoFlatlistData} from './FlatListPage';
import {SpinnerPullToRefreshHeader} from '../SpinnerPullToRefreshHeader';
import { Tester, Filter, TestCase, TestSuite } from '@rnoh/testerino';
function PullRefreshFlatList() {
    const [refreshing, setRefreshing] = useState(true);
    const [loadingMore, setLoadingMore] = useState(true);
    const [noMoreData, setNoMoreData] = useState(false);
    const {flatlistData, addFlatlistRefreshItem, addFlatlistLoadMoreItem} = useDemoFlatlistData();
    const pendingAction = useRef<ReturnType<typeof setTimeout> | null>(null);

    const clearPendingAction = () => {
        if (pendingAction.current) {
            clearTimeout(pendingAction.current);
        }
    };

    const beginRefresh = async () => {
        setRefreshing(true);
        pendingAction.current = setTimeout(() => {
            addFlatlistRefreshItem();
            endRefresh();
        }, 2000);
    };

    const endRefresh = () => {
        clearPendingAction();
        setRefreshing(false);
        setNoMoreData(false);
    };

    const loadMore = () => {
        setLoadingMore(true);
        pendingAction.current = setTimeout(() => {
            addFlatlistLoadMoreItem();
            endLoadMore();
        }, 3500);
    };

    const endLoadMore = () => {
        clearPendingAction();
        setLoadingMore(false);
        setNoMoreData(true);
    };

    return (
        <Tester style={{ flex: 1, marginTop: 30 }}>
<PullToRefresh
style={{height: '100%'}}
header={<SpinnerPullToRefreshHeader refreshing={refreshing} onRefresh={
    beginRefresh
} />}
    progressViewOffset={80} // 1.0.0+
    loadingMore={loadingMore}
    noMoreData={noMoreData}
    onLoadMore={loadMore}>
        <FlatListPage data={flatlistData} />
    </PullToRefresh>
    </Tester>
    );
}

export default PullRefreshFlatList;
Is supported autolink Supported RN Version
~1.0.0 Yes 0.82
~0.28.1 No 0.77
~0.27.1 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

2.1 Overrides RN SDK

为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 harmony/oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。

关于该字段的作用请阅读官方说明

{
  "overrides": {
    "@rnoh/react-native-openharmony": "^0.72.58"
  }
}

2.2 引入原生端代码

目前有两种方法:

  • 通过 har 包引入;
  • 直接链接源码。

方法一:通过 har 包引入(推荐)

har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 entry/oh-package.json5,添加以下依赖

"dependencies": {
    "@react-native-ohos/pull-to-refresh": "file:../../node_modules/@react-native-ohos/pull-to-refresh/harmony/pull_to_refresh.har"
  }

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)

2.3 配置 CMakeLists 和引入 PullToRefreshPackage

打开 entry/src/main/cpp/CMakeLists.txt,添加:

+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")

# RNOH_BEGIN: manual_package_linking_1
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/pull-to-refresh/src/main/cpp" ./pull_to_refresh)
# RNOH_END: manual_package_linking_1

# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_pull_to_refresh)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp,添加:

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "PullToRefreshPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
      std::make_shared<RNOHGeneratedPackage>(ctx),
+      std::make_shared<PullToRefreshPackage>(ctx)
    };
}

2.4 运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

3. 约束与限制

3.1 兼容性

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

在以下版本验证通过:

  1. RNOH: 0.72.98; SDK: HarmonyOS-5.0.0(API12); IDE: DevEco Studio 5.0.3.906; ROM: NEXT.0.0.71;
  2. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0.47 (API Version 20); IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.107;
  3. RNOH: 0.82.22; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.878; ROM: 6.0.0.130;

4. 属性

"Platform" 列表示这些属性在原始第三方库中支持的平台。

如果“HarmonyOS 支持”列的值为“yes”,则表示 HarmonyOS 平台支持该属性;“no”则表示不支持;“partially”表示部分支持该属性的功能。该属性在不同平台上的使用方法相同,效果与 iOS 或 Android 平台一致。

PullToRefresh属性

Name Description Type Required Platform HarmonyOS Support
refreshing Control the display and hide of the refresh head or bottom boolean YES All yes
noMoreData Control whether there is more data boolean NO All yes
loadingMore Control loading more boolean NO All yes
header Set the refresh head object NO All yes
footer Set the refresh footer object NO All yes
progressViewOffset 1.0.0+ Control the offset of the pull-to-refresh indicator (Header), in dp number NO All yes
requestDisallowInterceptTouchEvent 1.0.0+ Control whether the PullToRefresh component is prohibited from intercepting touch events, default: false boolean NO Android no

PullToRefreshHeader属性

Name Description Type Required Platform HarmonyOS Support
refreshing Control the display and hide of the refresh head or bottom boolean YES All yes
progressViewOffset 1.0.0+ Control the offset of the pull-to-refresh indicator (Header), in dp number NO All yes

RefreshControl属性

Name Description Type Required Platform HarmonyOS Support
refreshing Control the display and hide of the refresh head or bottom boolean YES All yes

PullToRefreshFooter属性

Name Description Type Required Platform HarmonyOS Support
refreshing Control the display and hide of the refresh head or bottom boolean YES All yes
noMoreData Control whether there is more data boolean NO All yes
manual Control the automatic pull-up loading function boolean NO All yes

5. 方法

PullToRefresh方法

Name Description Type Platform HarmonyOS Support
onRefresh Refresh callback function All yes
onLoadMore Load more callback function All yes

PullToRefreshHeader方法

Name Description Type Platform HarmonyOS Support
onRefresh Refresh callback function All yes
onStateChanged Refresh status callback function All yes
onOffsetChanged Refresh the offset callback function All yes

RefreshControl方法

Name Description Type Platform HarmonyOS Support
onRefresh Refresh callback function All yes

PullToRefreshFooter方法

Name Description Type Platform HarmonyOS Support
onRefresh Refresh callback function All yes
onStateChanged Refresh status callback function All yes
onOffsetChanged Refresh the offset callback function All yes

6. 遗留问题

7. 其他

8. 开源协议

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