Skip to content

Latest commit

 

History

History
245 lines (182 loc) · 8.27 KB

react-native-haptic-feedback.md

File metadata and controls

245 lines (182 loc) · 8.27 KB

模板版本：v0.2.2

react-native-haptic-feedback

Supported platforms License

[!TIP] Github 地址

安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：@react-native-oh-tpl/react-native-haptic-feedback Releases 。对于未发布到npm的旧版本，请参考安装指南安装tgz包。

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

npm

npm install @react-native-oh-tpl/react-native-haptic-feedback

yarn

yarn add @react-native-oh-tpl/react-native-haptic-feedback

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

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

import React from "react"
import { SafeAreaView, ScrollView, Button } from "react-native"
import ReactNativeHapticFeedback from "react-native-haptic-feedback"
const options = {
  enableVibrateFallback: false,
  ignoreAndroidSystemSettings: false,
}

const methods = [
  "impactLight",
  "impactMedium",
  "impactHeavy",
  "notificationSuccess",
  "notificationWarning",
  "notificationError",
  "rigid",
  "soft",
  "selection",
  "clockTick",
  "contextClick",
  "keyboardPress",
  "keyboardRelease",
  "keyboardTap",
  "longPress",
  "textHandleMove",
  "virtualKey",
  "virtualKeyRelease",
  "effectClick",
  "effectDoubleClick",
  "effectHeavyClick",
  "effectTick",
]

export const HapticFeedbackExample = () => {
  return (
    <SafeAreaView>
      <ScrollView>
        {methods.map((item) => {
          return (
            <Button
              title={item}
              onPress={() => ReactNativeHapticFeedback.trigger(item, options)}
              key={item}
            ></Button>
          )
        })}
      </ScrollView>
    </SafeAreaView>
  )
}

使用 Codegen

本库已经适配了 Codegen ，在使用前需要主动执行生成三方库桥接代码，详细请参考 Codegen 使用文档。

Link

目前鸿蒙暂不支持 AutoLink，所以 Link 步骤需要手动配置。

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

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

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "file:./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",
    "@react-native-oh-tpl/react-native-haptic-feedback": "file:../../node_modules/@react-native-oh-tpl/react-native-haptic-feedback/harmony/haptic_feedback.har"

  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

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

3.在 ArkTs 侧引入 RNHapticFeedbackPackage

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

...

+  import { RNHapticFeedbackPackage } from '@react-native-oh-tpl/react-native-haptic-feedback/ts'

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

4.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

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

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：@react-native-oh-tpl/react-native-haptic-feedback Releases

权限要求

在 entry/src/main/module.json5补上配置

"requestPermissions": [ { "name": "ohos.permission.VIBRATE" }, ]

静态方法

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

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

Available Methods

trigger(method, options) Use this method to trigger haptic feedback

Name Description Type Required Platform HarmonyOS Support
method Specifies the type of haptic feedback. See the list of available methods below. string yes iOS/Android yes
options.enableVibrateFallback iOS only. If haptic feedback is unavailable (iOS < 10 OR Device < iPhone6s), vibrate with default method (heavy 1s) (default: false). boolean no iOS no
options.ignoreAndroidSystemSettings Ignoreing phone mute mode setting and triggering haptic feedback. (default: false). boolean no Android yes

method Overview

Here's an overview of the available methods and their compatibility

Name Description Type Required Platform HarmonyOS Support
impactLight impactLight feedback string no iOS/Android yes
impactMedium impactMedium feedback string no iOS/Android yes
impactHeavy impactHeavy feedback string no iOS/Android yes
rigid rigid feedback string no iOS/Android yes
soft soft feedback string no iOS/Android yes
notificationSuccess notificationSuccess feedback string no iOS/Android yes
notificationWarning notificationWarning feedback string no iOS/Android yes
notificationError notificationError feedback string no iOS/Android yes
selection selection feedback string no iOS yes
clockTick clockTick feedback string no Android yes
contextClick contextClick feedback string no Android yes
keyboardPress keyboardPress feedback string no Android yes
keyboardRelease keyboardRelease feedback string no Android yes
keyboardTap keyboardTap feedback string no Android yes
longPress longPress feedback string no Android yes
textHandleMove textHandleMove feedback string no Android yes
virtualKey virtualKey feedback string no Android yes
virtualKeyRelease virtualKeyRelease feedback string no Android yes
effectClick effectClick feedback string no Android yes
effectDoubleClick effectDoubleClick feedback string no Android yes
effectHeavyClick effectHeavyClick feedback string no Android yes
effectTick effectTick feedback string no Android yes

遗留问题

  • 自定义振动文件配置问题: issue#6

其他

开源协议

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