@capacitor/haptics

触觉反馈 API 通过触摸或振动为用户提供物理反馈。

在不具有 Taptic Engine 或振动器的设备上，API 调用将解决而不执行任何操作。

安装

npm install @capacitor/haptics
npx cap sync

示例

import { Haptics, ImpactStyle } from '@capacitor/haptics';

const hapticsImpactMedium = async () => {
  await Haptics.impact({ style: ImpactStyle.Medium });
};

const hapticsImpactLight = async () => {
  await Haptics.impact({ style: ImpactStyle.Light });
};

const hapticsVibrate = async () => {
  await Haptics.vibrate();
};

const hapticsSelectionStart = async () => {
  await Haptics.selectionStart();
};

const hapticsSelectionChanged = async () => {
  await Haptics.selectionChanged();
};

const hapticsSelectionEnd = async () => {
  await Haptics.selectionEnd();
};

API

• impact(...)
• notification(...)
• vibrate(...)
• selectionStart()
• selectionChanged()
• selectionEnd()
• Interfaces
• Enums

impact(...)

impact(options?: ImpactOptions | undefined) => Promise<void>

触发触觉"冲击"反馈

Param	Type
options	ImpactOptions

Since: 1.0.0

---

notification(...)

notification(options?: NotificationOptions | undefined) => Promise<void>

触发触觉"通知"反馈

Param	Type
options	NotificationOptions

Since: 1.0.0

---

vibrate(...)

vibrate(options?: VibrateOptions | undefined) => Promise<void>

振动设备

Param	Type
options	VibrateOptions

Since: 1.0.0

---

selectionStart()

selectionStart() => Promise<void>

触发选择开始触觉提示

Since: 1.0.0

---

selectionChanged()

selectionChanged() => Promise<void>

触发选择更改触觉提示。如果已经开始选择，这将导致设备提供触觉反馈

Since: 1.0.0

---

selectionEnd()

selectionEnd() => Promise<void>

如果调用了 selectionStart()，selectionEnd() 将结束选择。例如，当用户从控件上抬起手指时调用此方法

Since: 1.0.0

---

Interfaces

ImpactOptions

Prop	Type	Description	Default	Since
style	ImpactStyle	冲击反馈样式 由 UIImpactFeedbackGenerator 对象模拟的碰撞中对象的质量。	ImpactStyle.Heavy	1.0.0

NotificationOptions

Prop	Type	Description	Default	Since
type	NotificationType	通知反馈类型 由 UINotificationFeedbackGenerator 对象生成的通知反馈类型。	NotificationType.SUCCESS	1.0.0

VibrateOptions

Prop	Type	Description	Default	Since
duration	number	振动持续时间（毫秒）。	300	1.0.0

Enums

ImpactStyle

Members	Value	Description	Since
Heavy	'HEAVY'	大型、重型用户界面元素之间的碰撞	1.0.0
Medium	'MEDIUM'	中等大小的用户界面元素之间的碰撞	1.0.0
Light	'LIGHT'	小型、轻型用户界面元素之间的碰撞	1.0.0

NotificationType

Members	Value	Description	Since
Success	'SUCCESS'	表示任务已成功完成的通知反馈类型	1.0.0
Warning	'WARNING'	表示任务产生警告的通知反馈类型	1.0.0
Error	'ERROR'	表示任务失败的通知反馈类型	1.0.0