How to Vibrate the Android Device on Button Click using Jetpack Compose?

Many times in android applications we want to add functionality to our application so that the device will get vibrate after performing some specific action within it. In this article, we will be building a simple application in which we will take a look at How to programmatically vibrate an android device using Jetpack Compose.

Step by Step Implementation

Step 1: Create a New Project in Android Studio

To create a new project in Android Studio please refer to How to Create/Start a New Project in Android Studio. While choosing the template, select Empty Compose Activity. If you do not find this template, try upgrading the Android Studio to the latest version. We demonstrated the application in Kotlin, so make sure you select Kotlin as the primary language while creating a New Project.

Step 2: Adding a new color in the Color.kt file

Navigate to app > java > your app’s package name > ui.theme > Color.kt file and add the below code to it. Comments are added in the code to get to know it in detail.

Kotlin

package com.example.newcanaryproject.ui.theme

import androidx.compose.ui.graphics.Color

val Purple200 = Color(0xFF0F9D58)
val Purple500 = Color(0xFF0F9D58)
val Purple700 = Color(0xFF3700B3)
val Teal200 = Color(0xFF03DAC5)

// on below line we are adding different colors.
val greenColor = Color(0xFF0F9D58)

Step 3: Adding permission for using Vibrate in AndroidManifest.xml

Navigate to the app > manifest > AndroidManifest.xml and add the below permission in the manifest tag. 

XML

<uses-permission android:name="android.permission.VIBRATE" />

Step 4: Working with the MainActivity.kt file

Go to the MainActivity.kt file and refer to the following code. Below is the code for the MainActivity.kt file. Comments are added inside the code to understand the code in more detail.

Kotlin

package com.example.newcanaryproject

import android.content.Context
import android.content.Intent
import android.content.IntentFilter
import android.os.Build
import android.os.Bundle
import android.os.VibrationEffect
import android.os.Vibrator
import android.text.style.TextAppearanceSpan
import android.util.Log
import android.view.View
import android.widget.TextView
import android.widget.Toast
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.annotation.RequiresApi
import androidx.compose.foundation.layout.*
import androidx.compose.material.*
import androidx.compose.runtime.Composable
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.text.font.Typeface
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp
import androidx.core.content.res.ResourcesCompat
import com.example.newcanaryproject.ui.theme.NewCanaryProjectTheme
import com.example.newcanaryproject.ui.theme.greenColor
import org.w3c.dom.Text

class MainActivity : ComponentActivity() {

    @RequiresApi(Build.VERSION_CODES.M)
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            NewCanaryProjectTheme {
                // on below line we are specifying background color for our application
                Surface(
                    // on below line we are specifying modifier and color for our app
                    modifier = Modifier.fillMaxSize(), color = MaterialTheme.colors.background
                ) {

                    // on the below line we are specifying
                      // the theme as the scaffold.
                    Scaffold(

                        // in scaffold we are specifying the top bar.
                        topBar = {

                            // inside top bar we are specifying
                            // background color.
                            TopAppBar(backgroundColor = greenColor,

                                // along with that we are specifying
                                // title for our top bar.
                                title = {

                                    // in the top bar we are specifying
                                    // title as a text
                                    Text(
                                        // on below line we are specifying
                                        // text to display in top app bar.
                                        text = "GFG",

                                        // on below line we are specifying
                                        // modifier to fill max width.
                                        modifier = Modifier.fillMaxWidth(),

                                        // on below line we are specifying
                                        // text alignment.
                                        textAlign = TextAlign.Center,

                                        // on below line we are specifying
                                        // color for our text.
                                        color = Color.White
                                    )
                                })
                        }) {
                        // on below line we are calling method to display UI
                        deviceVibrator(context = LocalContext.current)
                    }
                }
            }
        }
    }
}

// on below line creating a method to display UI.
@RequiresApi(Build.VERSION_CODES.M)
@Composable
fun deviceVibrator(context: Context) {

    // on below line we are creating a column,
    Column(
        // on below line we are
        // adding a modifier to it,
        modifier = Modifier
            .fillMaxSize()
            // on below line we are
            // adding a padding.
            .padding(all = 30.dp),
        horizontalAlignment = Alignment.CenterHorizontally,
        verticalArrangement = Arrangement.Center,
    ) {
        // on below line we are adding a text for heading.
        Text(
            // on below line we are specifying text
            text = "Device Vibrator in Android",
            // on below line we are
            // specifying text color,
            // font size and font weight
            color = greenColor,
            fontSize = 20.sp,
            fontWeight = FontWeight.Bold
        )

        val vibrator = context.getSystemService(Context.VIBRATOR_SERVICE) as Vibrator

        // on below line we are adding a spacer.
        Spacer(modifier = Modifier.height(10.dp))

        // on below line we are creating a button.
        Button(
            onClick = {

                // this effect creates the vibration of
                // default amplitude for 1000ms(1 sec)
                val vibrationEffect1: VibrationEffect =
                    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
                        VibrationEffect.createOneShot(1000, VibrationEffect.DEFAULT_AMPLITUDE)
                    } else {
                        Log.e("TAG", "Cannot vibrate device..")
                        TODO("VERSION.SDK_INT < O")
                    }

                // it is safe to cancel other
                // vibrations currently taking place
                vibrator.cancel()
                vibrator.vibrate(vibrationEffect1)
            },
            // on below line adding a
            // modifier for our button.
            modifier = Modifier
                .fillMaxWidth()
                .padding(10.dp)
        ) {
            // on below line adding a
            // text for our button.
            Text(text = "Normal Vibration")
        }

        // on below line we are adding a spacer.
        Spacer(modifier = Modifier.height(10.dp))

        // on below line we are creating a button.
        Button(
            onClick = {
                // this type of vibration requires API 29
                val vibrationEffect2: VibrationEffect
                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {

                    // create vibrator effect with the constant EFFECT_CLICK
                    vibrationEffect2 =
                        VibrationEffect.createPredefined(VibrationEffect.EFFECT_CLICK)

                    // it is safe to cancel other
                    // vibrations currently taking place
                    vibrator.cancel()
                    vibrator.vibrate(vibrationEffect2)
                }

            },
            // on below line adding
            // a modifier for our button.
            modifier = Modifier
                .fillMaxWidth()
                .padding(10.dp)
        ) {
            // on below line adding a
            // text for our button.
            Text(text = "Click Vibration")
        }

        // on below line we are adding a spacer.
        Spacer(modifier = Modifier.height(10.dp))

        // on below line we are creating a button.
        Button(
            onClick = {
                // this type of vibration requires API 29
                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {

                    // create vibrator effect with the constant EFFECT_DOUBLE_CLICK
                    val vibrationEffect3: VibrationEffect =
                        VibrationEffect.createPredefined(VibrationEffect.EFFECT_DOUBLE_CLICK)

                    // it is safe to cancel other
                    // vibrations currently taking place
                    vibrator.cancel()
                    vibrator.vibrate(vibrationEffect3)
                }
            },
            // on below line adding a
            // modifier for our button.
            modifier = Modifier
                .fillMaxWidth()
                .padding(10.dp)
        ) {
            // on below line adding a text for our button.
            Text(text = "Double Click Vibration")
        }

        // on below line we are adding a spacer.
        Spacer(modifier = Modifier.height(10.dp))

        // on below line we are creating a button.
        Button(
            onClick = {

                // this type of vibration requires API 29
                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {

                    // create vibrator effect with the constant EFFECT_TICK
                    val vibrationEffect4: VibrationEffect =
                        VibrationEffect.createPredefined(VibrationEffect.EFFECT_TICK)

                    // it is safe to cancel other
                    // vibrations currently taking place
                    vibrator.cancel()
                    vibrator.vibrate(vibrationEffect4)
                }
            },
            // on below line adding a
            // modifier for our button.
            modifier = Modifier
                .fillMaxWidth()
                .padding(10.dp)
        ) {
            // on below line adding
            // a text for our button.
            Text(text = "Tick Vibration")
        }

        // on below line we are adding a spacer.
        Spacer(modifier = Modifier.height(10.dp))

        // on below line we are creating a button.
        Button(
            onClick = {

                // this type of vibration requires API 29
                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {

                    // create vibrator effect with the
                    // constant EFFECT_HEAVY_CLICK
                    val vibrationEffect5: VibrationEffect =
                        VibrationEffect.createPredefined(VibrationEffect.EFFECT_HEAVY_CLICK)

                    // it is safe to cancel other
                    // vibrations currently taking place
                    vibrator.cancel()
                    vibrator.vibrate(vibrationEffect5)
                }

            },
            // on below line adding
            // a modifier for our button.
            modifier = Modifier
                .fillMaxWidth()
                .padding(10.dp)
        ) {
            // on below line adding a text for our button.
            Text(text = "Heavy Click Effect Vibration")
        }

    }
}

Now run your application to see the output of it. 

Output: