See how Capacitor fits into the entire Ionic Ecosystem ->
Capacitor is part of the Ionic Ecosystem ->

@capacitor/haptics

The Haptics API provides physical feedback to the user through touch or vibration.

Install

npm install @capacitor/haptics
npx cap sync

API

impact(…)

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

Trigger a haptics “impact” feedback

Param Type
options HapticsImpactOptions

Since: 1.0.0


notification(…)

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

Trigger a haptics “notification” feedback

Param Type
options HapticsNotificationOptions

Since: 1.0.0


vibrate(…)

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

Vibrate the device

Param Type
options VibrateOptions

Since: 1.0.0


selectionStart()

selectionStart() => Promise<void>

Trigger a selection started haptic hint

Since: 1.0.0


selectionChanged()

selectionChanged() => Promise<void>

Trigger a selection changed haptic hint. If a selection was started already, this will cause the device to provide haptic feedback

Since: 1.0.0


selectionEnd()

selectionEnd() => Promise<void>

If selectionStart() was called, selectionEnd() ends the selection. For example, call this when a user has lifted their finger from a control

Since: 1.0.0


Interfaces

HapticsImpactOptions

Prop Type Description Default Since
style HapticsImpactStyle Impact Feedback Style The mass of the objects in the collision simulated by a UIImpactFeedbackGenerator object. HapticsImpactStyle.Heavy 1.0.0

HapticsNotificationOptions

Prop Type Description Default Since
type HapticsNotificationType Notification Feedback Type The type of notification feedback generated by a UINotificationFeedbackGenerator object. HapticsNotificationType.SUCCESS 1.0.0

VibrateOptions

Prop Type Description Default Since
duration number Duration of the vibration in milliseconds. Not supported in iOS. 300 1.0.0

Enums

HapticsImpactStyle

Members Value Description Since
Heavy 'HEAVY' A collision between small, light user interface elements 1.0.0
Medium 'MEDIUM' A collision between moderately sized user interface elements 1.0.0
Light 'LIGHT' A collision between small, light user interface elements 1.0.0

HapticsNotificationType

Members Value Description Since
Success 'SUCCESS' A notification feedback type indicating that a task has completed successfully 1.0.0
Warning 'WARNING' A notification feedback type indicating that a task has produced a warning 1.0.0
Error 'ERROR' A notification feedback type indicating that a task has failed 1.0.0
Previous
<- Dialog
Next
Keyboard ->