npm package: @ohmi/react-native-pager-view
Description: React Native wrapper for Harmony ViewPager
Author: troZee
Latest version: 6.2.3-0.2.12

# @ohmi/react-native-pager-view

This project is based on [react-native-pager-view](https://github.com/callstack/react-native-pager-view)

[![Supported platforms](https://img.shields.io/badge/platforms-android%20%7C%20ios%20%7C%20harmony%20-lightgrey.svg) ](https://gitee.com/link?target=https%3A%2F%2Fgithub.com%2Fcallstack%2Freact-native-pager-view)[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://gitee.com/link?target=https%3A%2F%2Fgithub.com%2Fcallstack%2Freact-native-pager-view%2Fblob%2Fmaster%2FLICENSE)

> [!TIP] [Gitee地址](https://gitee.com/kunyuan-hongke/react-native-community-viewpager)

## 安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：[@ohmi/react-native-pager-view Releases](https://gitee.com/kunyuan-hongke/react-native-community-viewpager/releases/tag/6.2.3-0.2.8) 。对于未发布到npm的旧版本，请参考[安装指南](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/tgz-usage.md)安装tgz包。

进入到工程目录并输入以下命令：

#### **npm**

```
npm install @ohmi/react-native-pager-view
```

#### **yarn**

```
yarn add @ohmi/react-native-pager-view
```

下面的代码展示了这个库的基本使用场景：

> [!WARNING] 使用时 import 的库名不变。

```
import React from "react";
import { StyleSheet, View, Text } from "react-native";
import PagerView from "react-native-pager-view";

const MyPager = () => {
  return (
    <PagerView style={styles.pagerView} initialPage={0}>
      <View key="1">
        <Text>First page</Text>
      </View>
      <View key="2">
        <Text>Second page</Text>
      </View>
    </PagerView>
  );
};

const styles = StyleSheet.create({
  pagerView: {
    flex: 1,
  },
});
```

## Link

目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony`

### 在工程根目录的 `oh-package.json5` 添加 overrides字段

```
{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}
```

### 2.引入原生端代码

目前有两种方法：

1. 通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）；
2. 直接链接源码。

方法一：通过 har 包引入

> [!TIP] har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 `entry/oh-package.json5`，添加以下依赖

```
"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@ohmi/react-native-pager-view": "file:../../node_modules/@ohmi/react-native-pager-view/harmony/pager_view.har",
  }
```

点击右上角的 `sync` 按钮

或者在终端执行：

```
cd entry
ohpm install
```

方法二：直接链接源码

> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/link-source-code.md)

### 3.配置 CMakeLists 和引入 ViewPagerPackage

打开 `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: add_package_subdirectories
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@ohmi/react-native-pager-view/src/main/cpp" ./pager_view)
# RNOH_END: add_package_subdirectories

add_library(rnoh_app SHARED
    "./PackageProvider.cpp"
    "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)

target_link_libraries(rnoh_app PUBLIC rnoh)

# RNOH_BEGIN: link_packages
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_pager_view )
# RNOH_END: link_packages
```

打开 `entry/src/main/cpp/PackageProvider.cpp`，添加：

```
#include "RNOH/PackageProvider.h"
#include "SamplePackage.h"
+ #include "ViewPagerPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
      std::make_shared<SamplePackage>(ctx),
+     std::make_shared<ViewPagerPackage>(ctx)
    };
}
```

### 4.在 ArkTs 侧引入 ViewPagerPackage

打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加：

```
  ...
+ import { ViewPagerPackage } from '@ohmi/react-native-pager-view/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new ViewPagerPackage(ctx)
  ];
}
```

### 5.运行

点击右上角的 `sync` 按钮

或者在终端执行：

```
cd entry
ohpm install
```

然后编译、运行即可。

## 约束与限制

## 兼容性

要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@ohmi/react-native-pager-view Releases](https://gitee.com/kunyuan-hongke/react-native-community-viewpager/releases/tag/6.2.3-0.2.8) 。

> [!TIP] " HarmonyOS 支持"列为 yes 的 API 表示支持 HarmonyOS 平台，并且效果对标"原库平台"列中的 ios 或 android 的效果。

> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

| Name                                     | Description                                                  | Type                           | Required | Platform     | HarmonyOS Support          |
| ---------------------------------------- | ------------------------------------------------------------ | ------------------------------ | -------- | ------------ | -------------------------- |
| initialPage                              | Index of initial page that should be selected                | number                         | 是       | ios，android | yes                        |
| scrollEnabled                            | Should pager view scroll, when scroll enabled                | bool                           | 是       | ios，android | yes                        |
| onPageScroll                             | Executed when transitioning between pages (ether because the animation for the requested page has changed or when the user is swiping/dragging between pages) | function                       | 否       | ios，android | yes                        |
| onPageScrollStateChanged                 | Function called when the page scrolling state has changed    | function                       | 否       | ios，android | yes                        |
| onPageSelected                           | This callback will be called once the ViewPager finishes navigating to the selected page | function                       | 否       | ios，android | yes                        |
| pageMargin                               | Blank space to be shown between pages                        | number （取值范围:0~屏幕宽度） | 否       | ios，android | 仅支持取 0-368（屏幕宽度） |
| keyboardDismissMode                      | Determines whether the keyboard gets dismissed in response to a drag | one of 'none' ,'on-drag'       | 否       | ios,android  | yes                        |
| orientation                              | Set horizontal or vertical scrolling orientation (it does not work dynamically) | one of horizontal vertical     | 否       | ios，android | yes                        |
| overScrollMode                           | Used to override default value of overScroll mode. Can be auto, always or never. Defaults to auto | one of auto, always ,never     | 否       | android      | yes                        |
| offscreenPageLimit                       | Set the number of pages that should be retained to either side of the currently visible page(s). Pages beyond this limit will be recreated from the adapter when needed. Defaults to RecyclerView's caching strategy. The given value must either be larger than 0. | number                         | 否       | android      | no                         |
| overdrag                                 | Allows for overscrolling after reaching the end or very beginning or pages. Defaults to false | bool                           | 否       | ios          | yes                        |
| layoutDirection                          | Specifies layout direction. Use ltr or rtl to set explicitly or locale to deduce from the default language script of a locale. Defaults to locale | string                         | 否       | android,ios  | yes                        |
| setPage(index: number)                   | Function to scroll to a specific page in the PagerView. Invalid index is ignored. | function                       | 否       | android,ios  | yes                        |
| setPageWithoutAnimation(index: number)   | Function to scroll to a specific page in the PagerView. Invalid index is ignored. | function                       | 否       | android,ios  | yes                        |
| setScrollEnabled(scrollEnabled: boolean) | FA helper function to enable/disable scroll imperatively. The recommended way is using the scrollEnabled prop, however, there might be a case where a imperative solution is more useful (e.g. for not blocking an animation) | function                       | 否       | android,ios  | yes                        |

## 遗留问题

-  offscreenPageLimit 未实现 HarmonyOS 化[issue#7](https://gitee.com/link?target=https%3A%2F%2Fgithub.com%2Freact-native-oh-library%2Freact-native-pager-view%2Fissues%2F7)

## 其他

## 开源协议

本项目基于 [The MIT License (MIT)](https://gitee.com/link?target=https%3A%2F%2Fgithub.com%2Freact-native-oh-library%2Freact-native-pager-view%2Fblob%2Fharmony%2FLICENSE) ，请自由地享受和参与开源。