文档模板
模板版本:v0.4.0
react-native-idle-timer
本项目基于 原库react-native-idle-timer 开发。
该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-idle-timer 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-idle-timer | ~2.4.0 | Gitcode Releases | 0.82.* | 是 | API12+ | 2.2.3 | Npm Address |
| @react-native-ohos/react-native-idle-timer | ~2.3.0 | Gitcode Releases | 0.77 | 否 | API12+ | 2.2.3 | Npm Address |
| @react-native-ohos/react-native-idle-timer | ~2.2.4 | Gitcode Releases | 0.72 | 是 | API12+ | 2.2.3 | Npm Address |
| @react-native-oh-tpl/react-native-idle-timer | <= 2.2.3-0.0.1@deprecated | @react-native-oh-tpl/react-native-idle-timer Releases(deprecated) | 0.72 | 否 | API12+ | 2.2.3 | Npm Address |
1.安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-idle-timer
yarn
yarn add @react-native-ohos/react-native-idle-timer
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import React, { useEffect } from 'react';
import { View, Text, Button } from 'react-native';
import IdleTimerManager from 'react-native-idle-timer';
const IdleTimerExample = () => {
useEffect(() => {
// Disable the idle timer to prevent the screen from dimming or locking.
IdleTimerManager.setIdleTimerDisabled(true, "video");
// A cleanup function to re-enable the idle timer when the component is unmounted
return () => {
IdleTimerManager.setIdleTimerDisabled(false, "video");
};
}, []);
return (
<View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
<Text>By default, the screen will remain on</Text>
</View>
);
};
export default IdleTimerExample;
2.Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~2.4.0 | Yes | 0.82 |
| ~2.3.0 | No | 0.77 |
| ~2.2.4 | Yes | 0.72 |
| <= 2.2.3-0.0.1@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。
2.1在工程根目录的 oh-package.json5 添加 overrides 字段
{
...
"overrides": {
"@rnoh/react-native-openharmony" : "file:./react_native_openharmony"
}
}
2.2引入原生端代码
目前有两种方法:
- 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
- 直接链接源码。
方法一:通过 har 包引入(推荐)
har 包位于三方库安装路径的 `harmony` 文件夹下。
打开 entry/oh-package.json5,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony" : "file:../react_native_openharmony",
"@react-native-ohos/react-native-idle-timer": "file:../../node_modules/@react-native-ohos/react-native-idle-timer/harmony/idle_timer.har"
}
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3在 ArkTs 侧引入 RNIdleTimerPackage
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
...
import type {RNPackageContext, RNPackage} from '@rnoh/react-native-openharmony/ts';
+import {RNIdleTimerPackage} from '@react-native-ohos/react-native-idle-timer/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
+ new RNIdleTimerPackage(ctx)
];
}
2.4配置 CMakeLists 和引入 RNIdleTimerPackage
若使用的是 <= 2.2.3-0.0.1 版本,请跳过本章。
打开 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-idle-timer/src/main/cpp" ./idle_timer)
# 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_idle_timer)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
>若使用RN框架版本是0.77,头文件路径如下:
+ #include "generated/IdleTimerRNOHGeneratedPackage.h"
>若使用RN框架版本是0.72,头文件路径如下:
+ #include "IdleTimerPackage.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),
>若使用RN框架版本是0.77:
+ std::make_shared<IdleTimerRNOHGeneratedPackage>(ctx)
>若使用RN框架版本是0.72:
+ std::make_shared<IdleTimerPackage>(ctx)
};
}
2.5运行
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
然后编译、运行即可。
3.约束与限制
3.1兼容性
要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。
在以下版本验证通过:
- RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
- RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.82.7; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.328 SP26;
4.API
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| setIdleTimerDisabled | 启用/禁用屏幕空闲计时器 | function | no | All | yes |
5.遗留问题
6.其他
7.开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。