模板版本：v0.4.2

本项目基于 react-native-immersive 开发。

该第三方库的仓库已迁移至 Gitcode，且支持直接从 npm 下载，新的包名为：@react-native-ohos/react-native-immersive 版本所属关系如下：

|三方库名称| 三方库版本（npm地址）| 发布信息 | 支持RN版本 |Autolink|编译API版本|社区基线版本|源码地址| |-------|-------|-------------------------------------------------------------------------------------------------| ---------- |---------- |---------- |---------- |---------- | |@react-native-ohos/react-native-immersive| ~2.2.0 | Gitcode Releases | 0.82.* |是|API12+|2.0.0 |br_rnoh0.82|

简介

一款用于开启 Immersive Mode（沉浸式全屏模式），可以隐藏状态栏 + 底部导航栏；

安装与使用

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

npm

npm install @react-native-ohos/react-native-immersive

yarn

yarn add @react-native-ohos/react-native-immersive

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

[!WARNING] 使用时 import 的库名不变。

import React, { Component } from 'react'
import { AppRegistry, StyleSheet, Text, View, Button, TextInput, Alert, Modal } from 'react-native'
import { Immersive } from 'react-native-immersive'

class testReactNative extends Component {
  constructor (props) {
    super(props)
    
    Immersive.getImmersive().then((immersiveState) => {
        console.log('init [getImmersiveState]', immersiveState)
        this.setState({ immersiveState,isImmersive: immersiveState.isImmersiveOn })
        if(immersiveState.isImmersiveOn){
          Immersive.on()
        }
      }).catch((err) => {
        console.error('[getImmersiveState] error', err)
   })

    this.setImmersiveOn = () => {
      let startTime = Date.now();
      Immersive.on()
      let endTime = Date.now();
      console.log("react-native-immersive on time:", endTime - startTime, "ms");
      this.setState({ isImmersive: true })
    }
    this.setImmersiveOff = () => {
      let startTime = Date.now();
      Immersive.off()
      let endTime = Date.now();
      console.log("react-native-immersive off time:", endTime - startTime, "ms");
      this.setState({ isImmersive: false })
    }
    this.setImmersiveTrue = () => {
      let startTime = Date.now();
      Immersive.setImmersive(true)
      let endTime = Date.now();
      console.log("react-native-immersive setImmersive time:", endTime - startTime, "ms");
      this.setState({ isImmersive: true })
    }
    this.setImmersiveFalse = () => {
      Immersive.setImmersive(false)
      this.setState({ isImmersive: false })
    }
    this.addImmersiveListener = () => {
      if(!this.state.isAddListener){
        console.log("Immersive---------> addImmersiveListener",this.restoreImmersive);
        let startTime = Date.now();
        Immersive.addImmersiveListener(this.restoreImmersive)
        let endTime = Date.now();
        console.log("react-native-immersive addImmersiveListener time:", endTime - startTime, "ms");
        this.setState({ isAddListener: true })
      }
    }
    this.removeImmersiveListener = () => {
      if(this.state.isAddListener){
        console.log("Immersive---------> removeImmersiveListener",this.restoreImmersive);
        let startTime = Date.now();
        Immersive.removeImmersiveListener(this.restoreImmersive)
        let endTime = Date.now();
        console.log("react-native-immersive removeImmersiveListener time:", endTime - startTime, "ms");
        this.setState({ isAddListener: false })
      }
    }

  
    this.getImmersiveState = () => {
      let startTime = Date.now();
      Immersive.getImmersive().then((immersiveState) => {
        let endTime = Date.now();
        console.log("react-native-immersive getImmersive time:", endTime - startTime, "ms");
        console.log('[getImmersiveState]', immersiveState)
        this.setState({ immersiveState })
      }).catch((err) => {
        console.error('[getImmersiveState] error', err)
      })
    }

    this.restoreImmersive = () => {
      Alert.alert("Callback","The registered listener callback has been invoked")
    }

    this.state = {
      isAddListener: false,
      isImmersive: false,
      isRestoreImmersive: true,
      immersiveState: null
    }
  }

  render () {
    const { isImmersive, immersiveState } = this.state
    return (
      <View style={{margin: 16}}>
            <Button onPress={this.addImmersiveListener} title="addImmersiveListener" />
            <View style={{ marginTop: 10, marginBottom: 10 }}>
                <Button style={{marginTop: 10, marginBottom: 10}} onPress={this.removeImmersiveListener} title="removeImmersiveListener" />
            </View>
            <Button onPress={isImmersive ? this.setImmersiveOff : this.setImmersiveOn} title="on/off" />
            <Text style={styles.text}>isImmersive: {JSON.stringify(isImmersive)}</Text>
            <View style={{ marginTop: 10, marginBottom: 10 }}>
              <Button onPress={isImmersive ? this.setImmersiveFalse : this.setImmersiveTrue} title="setImmersive" />
            <Text style={styles.text}>isImmersive: {JSON.stringify(isImmersive)}</Text>
            </View>
            <Button onPress={this.getImmersiveState} title="getImmersive" />
            <Text style={styles.text}>immersiveState: {JSON.stringify(immersiveState)}</Text>
      </View>
    )
  }
}

const styles = StyleSheet.create({
  container: { flex: 1, padding: 24 },
  containerTest: { alignItems: 'stretch', justifyContent: 'center', flex: 1 },
  text: { textAlign: 'center', fontSize: 14 }
})

export default testReactNative;
AppRegistry.registerComponent('testReactNative', () => testReactNative)

Link

| | 是否支持autolink | RN框架版本 | |--------------------------------------|-----------------|------------| | ~2.2.0 | Yes | 0.82 |

使用AutoLink的工程需要根据该文档配置，Autolink框架指导文档：https://gitcode.com/CPF-RN/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md

如您使用的版本支持 Autolink，并且工程已接入 Autolink，可跳过ManualLink配置。

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony

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

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

引入原生端代码

目前有两种方法：

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

方法一：通过 har 包引入（推荐）

[!TIP] har 包位于三方库安装路径的 harmony 文件夹下。

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

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

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 如需使用直接链接源码，请参考直接链接源码说明

配置 CMakeLists 和引入 RNCVideoPackage

打开 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-immersive/src/main/cpp" ./rnoh_immersive)

# RNOH_BEGIN: 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_immersive)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp，添加：

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

在 ArkTs 侧引入 RNCVideoPackage

打开 entry/src/main/ets/RNPackagesFactory.ts，添加：

  ...
+ import { RNImmersivePackage } from '@react-native-ohos/react-native-immersive/ts';

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

运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

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

在以下版本验证通过。

1. RNOH: 0.82.7; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1.260; ROM: 6.0.0.130 SP15;

编译运行API要求

[!TIP] 当前三方库所有版本均已实现版本隔离，支持在 API12+ 工程编译，及 API12+ ROM运行。

[!TIP] 以下功能依赖特定版本的API，使用 低于指定API版本的工程编译 或 低于指定API版本的ROM运行 均可能导致部分功能受限。

1. 此库所有版本引入isImmersiveLayout，实现了获取当前窗口是否是沉浸式的功能，此API需要在支持API12+的工程编译，并在支持API20+的ROM上运行，方可生效。

静态方法

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

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 Android 的效果。

| Name | Description | Type | Required | Platform | HarmonyOS Support | | ------------------------- | ------------ | -------- | -------- | -------- | ----------------- | | on() | 设置全屏 | function | No | Android | yes | | off() | 关闭全屏 | function | No | Android | yes | | setImmersive() | 设置全屏状态 | function | No | Android | yes | | getImmersive() | 获取全屏状态 | function | No | Android | yes | | addImmersiveListener() | 添加监听 | function | No | Android | yes | | removeImmersiveListener() | 取消监听 | function | No | Android | yes |

遗留问题

不涉及

其他

目录结构

react-native-immersive
├── index.js                              # RN 入口文件，封装 Immersive API
├── NativeRNImmersive.ts                  # TurboModule 类型定义
├── package.json                          # npm 包配置
├── LICENSE                               # MIT 开源协议
├── OAT.xml                               # 开源审核配置
│
├── harmony/                              # HarmonyOS 原生模块
│   ├── immersive.har                     # 预编译 HAR 包
│   └── immersive/
│       ├── build-profile.json5           # 构建配置
│       ├── hvigorfile.ts                 # Hvigor 构建脚本
│       ├── oh-package.json5              # OHPM 包配置
│       └── src/
│           └── main/
│               ├── module.json5          # 模块声明
│               ├── cpp/                  # C++ 原生层
│               │   ├── CMakeLists.txt
│               │   ├── RNImmersivePackage.h
│               │   └── generated/        # 代码生成产物
│               ├── ets/                  # ArkTS 原生层
│               │   ├── RNImmersiveModule.ts   # TurboModule 实现
│               │   ├── RNImmersivePackage.ts  # Package 注册
│               │   └── generated/             # 代码生成产物
│               └── resources/            # 国际化资源
│                   ├── base/
│                   ├── en_US/
│                   └── zh_CN/
│── README_en.md           # 英文安装使用方法    
├── README.md   # 中文安装使用方法  

贡献代码

使用过程中发现任何问题都可以提交 Issue，当然，也非常欢迎提交 PR。

开源协议

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