Kotlin Multiplatform utility library for vibrate📱!

In lib.versions.toml include this dependency version catalog

[versions]
vibrate = "1.1.0"

[libraries]
vibrate = { module = "io.github.jmseb3:vibrate", version.ref = "vibrate" }

commonMain.dependencies {
    implementation(libs.vibrate)
}

or In build.gradle of app module, include this dependency

commonMain.dependencies {
    implementation("io.github.jmseb3:vibrate:1.1.0")
}

Example app source lives in sample/.

• JS browser: ./gradlew :sample:webApp:jsBrowserDevelopmentRun --continue
• WASM browser: ./gradlew :sample:webApp:wasmJsBrowserDevelopmentRun --continue
• Android: run sample:androidApp from Android Studio
• iOS: open sample/iosApp/iosApp.xcodeproj in Xcode and run

All durations are in milliseconds.

if (VibratorManager.isSupported()) {
    VibratorManager.vibrate(300)
}

VibratorManager.vibrate(3000)

3000 means 3 seconds.

VibratorManager.vibrate(3000, strength = 0.5f)
VibratorManager.vibrate(
    VibrationPreset.Success,
    strength = 0.8f
)

strength uses a normalized 0f..1f range.

• Android maps it to vibration amplitude.
• iOS maps it to Core Haptics intensity.
• JS/Wasm currently ignore it because the browser vibration API only supports timing patterns.

VibratorManager.vibratePattern(listOf(300, 500, 700, 500))

[300, 500, 700, 500] means:

• wait 300ms
• vibrate 500ms
• wait 700ms
• vibrate 500ms

You can also use typed patterns:

VibratorManager.vibratePattern(
    listOf(
        VibratePattern(delay = 0, vibrate = 80),
        VibratePattern(delay = 60, vibrate = 120)
    )
)

Built-in presets are available through VibrationPreset.

VibratorManager.vibrate(VibrationPreset.Success)
VibratorManager.vibrate(VibrationPreset.Error)

Available presets:

• VibrationPreset.Success
• VibrationPreset.Click
• VibrationPreset.DoubleClick
• VibrationPreset.Tick
• VibrationPreset.Warning
• VibrationPreset.Error
• VibrationPreset.Heartbeat
• VibrationPreset.Sos

If you want to inspect or customize a preset, you can also read its pattern list:

val successPattern = VibrationPreset.Success.patterns
val successDuration = VibrationPreset.Success.durationMillis

VibratorManager.stopVibrate()

This feature is supported by the Vibrate API.

For more detailed information, please refer to the official documentation:

Vibrate Api