模板版本:v0.4.0

react-native-vibration-feedback

本项目基于 react-native-vibration-feedback 开发。

该第三方库支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-vibration-feedback 版本所属关系如下:

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-vibration-feedback ~ 1.2.0 Github Releases 0.82.* API12+ 1.0.0 Npm Address
@react-native-ohos/react-native-vibration-feedback ~1.1.0 Github Releases 0.77.* API12+ 1.0.0 Npm Address
@react-native-ohos/react-native-vibration-feedback ~1.0.1 Github Releases 0.72.* API12+ 1.0.0 Npm Address

1. 安装与使用

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

npm

npm install @react-native-ohos/react-native-vibration-feedback

yarn

yarn add @react-native-ohos/react-native-vibration-feedback

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

使用时 import 的库名不变。

import React from "react";
import { View, Button} from "react-native";
import RNVibrationFeedback from 'react-native-vibration-feedback';

const App = (props) => {

  return (
    <View style={{ margin: 50, flexDirection: "column", justifyContent: "space-between" }}>
      <View>
        <Button
          title="Peek"
          onPress={() => RNVibrationFeedback.vibrateWith(1519)}
        />
        <Button
          title="Pop"
          onPress={() => RNVibrationFeedback.vibrateWith(1520)}
        />
        <Button
          title="Nope"
          onPress={() => RNVibrationFeedback.vibrateWith(1521)}
        />
      </View>
    </View>
  );
};

export default App
是否支持autolink RN框架版本
~1.2.0 Yes 0.82
~1.1.0 No 0.77
~1.0.1 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. Overrides RN SDK

为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。

关于该字段的作用请阅读官方说明

{
  "overrides": {
    "@rnoh/react-native-openharmony": "^0.72.38" // ohpm 在线版本
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // 指向本地 har 包的路径
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony" // 指向源码路径
  }
}

2.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-vibration-feedback": "file:../../node_modules/@react-native-ohos/react-native-vibration-feedback/harmony/vibration_feedback.har"
  }

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

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

2.3. 配置 CMakeLists 和引入 ReactNativeVibrationFeedbackPackage

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

project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")

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-vibration-feedback/src/main/cpp" ./vibration-feedback)
# RNOH_BEGIN: manual_package_linking_1

add_library(rnoh_app SHARED
    "./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_vibration_feedback)
# RNOH_BEGIN: manual_package_linking_2

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

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

2.4. 在 ArkTs 侧引入 RNVibrationFeedbackPackage

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

  ...
+   import {RNVibrationFeedbackPackage} from '@react-native-ohos/react-native-vibration-feedback/ts';

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

2.5. 运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

3. 约束与限制

3.1. 兼容性

本文档内容基于以下版本验证通过:

  1. RNOH:0.72.90; SDK:HarmonyOS 5.1.0.150 (API Version 12); IDE:DevEco Studio 6.0.0.858; ROM:6.0.0.112;
  2. RNOH:0.72.90; SDK:HarmonyOS 5.1.0.150 (API Version 12); IDE:DevEco Studio 6.0.0.858; ROM:5.0.0.102;
  3. RNOH:0.77.18; SDK:HarmonyOS 5.1.0.150 (API Version 12); IDE:DevEco Studio 6.0.0.858; ROM:6.0.0.112;
  4. RNOH:0.77.18; SDK:HarmonyOS 5.1.0.150 (API Version 12); IDE:DevEco Studio 6.0.0.858; ROM:5.0.0.102;
  5. RNOH: 0.82.7; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1.260; ROM: 6.0.0.130 SP15;

3.2. 权限要求

  • 由于此库涉及振动功能,使用对应接口时则需要配置对应的权限,权限需配置在entry/src/main目录下module.json5文件中。其中部分权限需弹窗向用户申请授权。具体权限配置见文档:程序访问控制

  • 此库部分功能与接口需要normal权限:ohos.permission.VIBRATE

4. 静态方法

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

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

RNVibrationFeedback

Name Description Type Required Platform HarmonyOS Support
vibrateWith(id: number) 触发指定id的震动 void yes openHarmony yes

5. 遗留问题

6. 其他

提供以下三种震动类型

ID Name Description
1519 Peek 弱短震动
1520 Pop 强烈的短震动
1521 Nope 短时间内三次震动

1521这个震动需要在API18以上才会生效,API18以下使用该震动,会自动变为1519的震动类型。

7. 开源协议

本项目基于 Apache License 2.0,请自由地享受和参与开源。