From 6130fa9dc9d8d0a8aeefb04146bb4a128a518095 Mon Sep 17 00:00:00 2001 From: meimei0321 <2983689841@qq.com> Date: Tue, 28 May 2024 11:19:32 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20[Issues:=20#I9SQFG]=20=E6=96=B0?= =?UTF-8?q?=E5=A2=9Ereact-native-spring-scrollview=E6=8C=87=E5=AF=BC?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- zh-cn/react-native-spring-scrollview.md | 237 ++++++++++++++++++++++++ 1 file changed, 237 insertions(+) create mode 100644 zh-cn/react-native-spring-scrollview.md diff --git a/zh-cn/react-native-spring-scrollview.md b/zh-cn/react-native-spring-scrollview.md new file mode 100644 index 00000000..c34dd655 --- /dev/null +++ b/zh-cn/react-native-spring-scrollview.md @@ -0,0 +1,237 @@ +> 模板版本：v0.2.1 + +

+

react-native-spring-scrollview

+

+

+ + Supported platforms + + + License + + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-spring-scrollview) + + + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-spring-scrollview Releases](https://github.com/react-native-oh-library/react-native-spring-scrollview/releases)，并下载适用版本的 tgz 包。 + + +进入到工程目录并输入以下命令： + +> [!TIP] # 处替换为 tgz 包的路径 + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-spring-scrollview@file:# +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-spring-scrollvie>@file:# +``` + + + +下面的代码展示了这个库的基本使用场景： + +> [!WARNING] 使用时 import 的库名不变。 + +```js +import React from "react"; +import { Text, View } from "react-native"; +import SpringScrollView from "react-native-spring-scrollview"; + +const SpringScrollViewDemo = () => { + return ( + (this._scrollView = ref)} + onTouchBegin={this._onTouchBegin} + onTouchEnd={this._onTouchEnd} + onMomentumScrollBegin={this.onMomentumScrollBegin} + onMomentumScrollEnd={this._onMomentumScrollEnd} + onScrollBeginDrag={this._onScrollBeginDrag} + onScrollEndDrag={this._onScrollEndDrag} + onNativeContentOffsetExtract={this._nativeOffset} + > + {arr.map((i, index) => ( + + Scroll and Look up the console log to check if + 'onScroll','onTouchBegin','onTouchEnd','onMomentumScrollBegin' and + 'onMomentumScrollEnd' work well! + + ))} + + Test `onNativeContentOffsetExtract` + + + ); +}; +``` + +## Link + +目前鸿蒙暂不支持 AutoLink，所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的鸿蒙工程 `harmony` + +### 在工程根目录的 `oh-package.json` 添加 overrides 字段 + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 引入原生端代码 + +目前有两种方法： + +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/rnoh-spring-scrollview": "file:../../node_modules/@react-native-oh-tpl/react-native-spring-scrollview/harmony/spring_scrollview.har" + + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +方法二：直接链接源码 + +> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md) + +### 配置 CMakeLists 和引入 xxxPackge + +打开 `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-spring-scrollview/src/main/cpp" ./spring-scrollview) + +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_END: manual_package_linking_2 ++ target_link_libraries(rnoh_app PUBLIC rnoh_safe_area) +``` ++target_link_libraries(rnoh_app PUBLIC rnoh_spring_scrollview) +打开 `entry/src/main/cpp/PackageProvider.cpp`，添加： + +```diff +#include "RNOH/PackageProvider.h" +#include "generated/RNOHGeneratedPackage.h" +#include "SamplePackage.h" ++ #include "SpringScrollViewPackage.h" +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), + std::make_shared(ctx), ++ std::make_shared(ctx), + }; +} +``` + +## 约束与限制 + +### 兼容性 + + +要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-spring-scrollview Releases](https://github.com/react-native-oh-library/react-native-spring-scrollview/releases) + +本文档内容基于以下版本验证通过： + +1.RNOH：0.72.23; SDK：HarmonyOS NEXT Developer Beta1; IDE：DevEco Studio 5.0.3.228; ROM：3.0.0.19 + + +### 权限要求 + +（填入相关权限配置） + +// 修改后 +Needed for Android and harmony to work properly with assets, iOS will ignore it. +``` + +## 属性 + +> [!tip] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ---- | ----------- | ---- | -------- | -------- | ------------------ | +| bounces | 滑动超出内容视图后是否可以弹性地继续滑动(iOS & Android，如果为true，水平方向内容视图如果没有超过SpringScrollView则不会有弹性，垂直方向始终具有弹性）|boolean | 是 | ios、Android | yes | +|scrollEnabled | 是否可以滚动 |boolean |是 | ios、Android | yes | +|initialContentOffset | 初始化偏移，仅第一次初始化有效，后期更改无效（已支持x方向）|number |ios、Android | yes | +|refreshHeaderHeight | 下拉刷新头部的高度 | number |是 |ios、Android | yes | +|loadingFooterHeight | 底部加载高度 | number | 是 |ios、Android | yes | +|decelerationRate | 减速率（拖拽、滑动、刷新） |number |是 | ios、Android | yes | +|allLoaded | 加载全部 |boolean |ios、Android | yes | +|inverted | 上下翻转 | boolean |是 |ios、Android | yes | +|directionalLockEnabled | 支持双向滑动的情况下，控制一次滑动只允许水平或垂直一个方向 | boolean | 是 |ios、Android | yes | +|pagingEnabled | 当值为 true 时，滚动条会停在设置的pageSize整数倍位置。这个属性在iOS和安卓上都支持双向分页。 |boolean |ios、Android | yes | +|pageSize | 配合pagingEnabled使用分页，使滑动停止在设置的整数倍位置。同时支持水平和垂直双向分页。0代表使用SpringScrollView的视口大小。 | number |是 |ios、Android | yes | + + +## 遗留问题 + + +## 其他 + +## 开源协议 + +本项目基于 [The MIT License](https://github.com/bolan9999/react-native-spring-scrollview/blob/master/LICENSE) ，请自由地享受和参与开源。 -- Gitee