模板版本:v0.2.2

react-native-spring-scrollview

Supported platforms License

[Github 地址](https://github.com/react-native-oh-library/react-native-spring-scrollview)

安装与使用

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

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-spring-scrollview 3.1.0 @react-native-ohos/react-native-spring-scrollview Releases 0.77/0.82 API12+ 3.0.2 Npm Address
@react-native-ohos/react-native-spring-scrollview 3.0.3 @react-native-ohos/react-native-spring-scrollview Releases 0.72 API12+ 2.0.22 Npm Address
@react-native-oh-tpl/react-native-spring-scrollview <= 3.0.2-0.0.4@deprecated @react-native-oh-tpl/react-native-spring-scrollview Releases(deprecated) 0.72 API12+ 2.0.22 Npm Address

对于未发布到npm的旧版本,请参考安装指南安装tgz包。

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

npm

npm install @react-native-ohos/react-native-spring-scrollview

yarn

yarn add @react-native-ohos/react-native-spring-scrollview

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

使用时 import 的库名不变。

import React from 'react';
import {
  StyleSheet,
  Text,
  TouchableOpacity,
  View,
  Platform,
  Animated
} from 'react-native';
import {SpringScrollView} from 'react-native-spring-scrollview';
export default class ScrollToAndOnScrollExample extends React.Component {
  _contentCount = 20;
  _scrollView;
  render() {
    const arr = [];
    for (let i = 0; i < this._contentCount; ++i) arr.push(i);
    return (
      <View style={styles.container}>
        <TouchableOpacity style={styles.scrollTo} onPress={this._scrollTo}>
          <Text>Tap to ScrollTo y=200</Text>
        </TouchableOpacity>
        <TouchableOpacity style={styles.scrollTo} onPress={this._scroll}>
          <Text>scroll</Text>
        </TouchableOpacity>
        <TouchableOpacity style={styles.scrollTo} onPress={this._scrollToBegin}>
          <Text>scrollToBegin</Text>
        </TouchableOpacity>
        <TouchableOpacity style={styles.scrollTo} onPress={this._scrollToEnd}>
          <Text>scrollToEnd</Text>
        </TouchableOpacity>
        <SpringScrollView
          style={styles.container}
          ref={(ref) => (this._scrollView = ref)}
          onTouchBegin={this._onTouchBegin}
          onTouchEnd={this._onTouchEnd}
          onMomentumScrollBegin={this.onMomentumScrollBegin}
          onMomentumScrollEnd={this._onMomentumScrollEnd}
          onScrollBeginDrag={this._onScrollBeginDrag}
          onSizeChange={this._onSizeChange}
          onContentSizeChange={this._onContentSizeChange}
          onScroll={this._onScroll}
          >
          {arr.map((i, index) => (
            <Text key={index} style={styles.text}>
              Scroll and Look up the console log to check if
              'onScroll','onTouchBegin','onTouchEnd','onMomentumScrollBegin' and
              'onMomentumScrollEnd' work well!
            </Text>
          ))}
        </SpringScrollView>
      </View>
    );
  }
  _onScroll = offset => {
    console.log("onScroll", offset.nativeEvent);
  };
  _onSizeChange= (wh) => {
    console.log('onSizeChange:'+JSON.stringify(wh));
  };
  _onContentSizeChange= (wh) => {
    console.log('onContentSizeChange:'+JSON.stringify(wh));
  };
  _onNativeContentOffsetExtract = () => {
    console.log('onNativeContentOffsetExtract');
  };
  _onScrollBeginDrag = () => {
    console.log('onScrollBeginDrag');
  };
  _scroll = () => {
    console.log('scroll');
    if (this._scrollView) {
      this._scrollView
        .scroll({x: 0, y: 200});
    }
  };
  _scrollTo = () => {
    console.log('scrollTo');
    if (this._scrollView) {
      this._scrollView
        .scrollTo({x: 0, y: 200})
        .then(() => console.log('ScrollTo has finished'));
    }
  };
  _scrollToBegin = () => {
    console.log('scrollToBegin');
    if (this._scrollView) {
      this._scrollView.scrollToBegin(true);
    }
  };
  _scrollToEnd = () => {
    console.log('scrollToEnd');
    if (this._scrollView) {
      this._scrollView.scrollToEnd(true);
    }
  };
  _onTouchBegin = () => {
    console.log('onTouchBegin');
  };
  _onTouchEnd = () => {
    console.log('onTouchEnd');
  };
  onMomentumScrollBegin = () => {
    console.log('onMomentumScrollBegin');
  };
  _onMomentumScrollEnd = () => {
    console.log('onMomentumScrollEnd');
  };
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
  },
  scrollTo: {
    marginTop: Platform.OS === 'ios' ? 20 : 0,
    backgroundColor: 'gray',
    zIndex: 100,
    height: 50,
    justifyContent: 'center',
    alignItems: 'center',
  },
  text: {
    fontSize: 16,
    margin: 20,
  },
});
是否支持autolink RN框架版本
~3.1.0 No 0.77/0.82
~3.0.3 Yes 0.72
<= 3.0.2-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

本库HarmonyOS侧实现依赖@react-native-ohos/lottie-react-native、@react-native-ohos/async-storage的原生端代码,如已在HarmonyOS工程中引入过该库,则无需再次引入,可跳过本章步骤,直接使用。

如未引入请参考@react-native-ohos/lottie-react-native文档的link章节@react-native-ohos/async-storage文档的link章节进行引入

1.在工程根目录的 oh-package.json5 添加 overrides 字段

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}

2.引入原生端代码

目前有两种方法:

  1. 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
  2. 直接链接源码。

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

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

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

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-ohos/react-native-spring-scrollview": "file:../../node_modules/@react-native-ohos/react-native-spring-scrollview/harmony/spring_scrollview.har",
  }

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

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

3.配置 CMakeLists 和引入 SpringScrollViewPackge

若使用的是 <= 3.0.2-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-ohos/react-native-spring-scrollview/src/main/cpp" ./spring_scrollview)
# 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_spring_scrollview)
# RNOH_END: manual_package_linking_2

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

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "SpringScrollViewPackage.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<SpringScrollViewPackage>(ctx),
    };
}

4.在 ArkTs 侧引入 SpringScrollViewPackage

打开 entry/src/main/ets/RNPackagesFactory.ts,添加:

  ...
+ import {SpringScrollViewPackage} from '@react-native-ohos/react-native-spring-scrollview/ts';

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

运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

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

在以下版本验证通过:

  1. RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  2. RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
  3. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  4. RNOH: 0.82.1; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.120 SP7

属性

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

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

Name Description Type Required Platform HarmonyOS Support
contentStyle set content style ViewStyle no iOS/Android yes
bounces Bounces if the content offset is out of the content view. It won't be bounces on the horizontal direction if the content view is not wider than the wrapper view although bounces is true. But it will on the vertical direction. boolean no iOS/Android yes
scrollEnabled scrollEnabled boolean no iOS/Android yes
directionalLockEnabled When true, the SpringScrollView will try to lock to only vertical or horizontal scrolling while dragging. boolean no iOS/Android yes
initialContentOffset initial content offset. Only works when initiation. Offset no iOS/Android yes
showsVerticalScrollIndicator showsVerticalScrollIndicator boolean no iOS/Android yes
showsHorizontalScrollIndicator showsHorizontalScrollIndicator boolean no iOS/Android yes
refreshHeader refresh header React.ComponentClass<RefreshHeaderPropType,RefreshHeaderStateType> no iOS/Android yes
loadingFooter loading header React.ComponentClass<LoadingFooterPropType,LoadingFooterStateType> no iOS/Android yes
onRefresh he callback when refreshing. When this props is configured, a refresh header will be add on the top of the SpringScrollView ()=>any no iOS/Android yes
onLoading() The callback of loading. If set this prop, a loading footer will add to the botom of the SpringScrollView ()=>any no iOS/Android yes
allLoaded Whether the data is all loaded. boolean no iOS/Android yes
textInputRefs text input any[] no iOS/Android yes
inverted inverted. It is a service for LargeList. boolean no iOS/Android yes
inputToolBarHeight set height of the input toolbar number no iOS/Android yes
dragToHideKeyboard hide the currently displayed keyboard boolean no iOS/Android yes
onTouchBegin() begin touch ()=>any no iOS/Android yes
onTouchEnd() touch finished ()=>any no iOS/Android yes
beginRefresh() If you want to begin refreshing programally without finger draging, call this method after initialized. Promise no iOS/Android yes
endRefresh() End the refreshing status. void no iOS/Android yes
endLoading() End the loading status. void no iOS/Android yes
scrollTo() animate scroll to a specific position Promise no iOS/Android yes
scroll() scroll animation to a specific position Promise no iOS/Android yes
scrollToBegin() scroll begin Promise no iOS/Android yes
scrollToEnd() scroll end Promise no iOS/Android yes
onScroll() scroll (evt: ScrollEvent) => any no iOS/Android yes
onNativeContentOffsetExtract calculate content offset NativeContentOffset no iOS/Android yes
onScrollBeginDrag() an event that is triggered when the user starts dragging (scrolling) content. ()=>any no iOS/Android yes
onMomentumScrollBegin() When the user scrolls content and the momentum scroll animation begins, it triggers an event. ()=>any no iOS/Android yes
onMomentumScrollEnd() When the user scrolls content and the momentum scroll animation ends, it triggers an event. ()=>any no iOS/Android yes
onSizeChange The callback when the wrapper view size changed. (size: Size) => any no iOS/Android yes
onContentSizeChange The callback when the content view size changed. (size: Size) => any no iOS/Android yes

遗留问题

其他

开源协议

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