CODEWITHSUNDEEP
androidandroid-softkeyboardkotlin
Eugene Trifonov
Eugene Trifonov

Reputation: 1261

Close/hide the Android Soft Keyboard with Kotlin

I'm trying to write a simple Android app in Kotlin. I have an EditText and a Button in my layout. After writing in the edit field and clicking on the Button, I want to hide the virtual keyboard.

There is a popular question Close/hide the Android Soft Keyboard about doing it in Java, but as far as I understand, there should be an alternative version for Kotlin. How should I do it?

Upvotes: 116

Views: 120649

Answers (19)

Waseem
Waseem

Reputation: 527

You can it with single word in Kotlin.

hideKeyboard()

call this function when you need

Upvotes: -1

Vishal Shah
Vishal Shah

Reputation: 452

Hello I frequently use these two extension functions for showing and hiding soft keyword.

  1. Show Soft Keyboard

    fun Any.showSoftKeyboard(view: View, context: Context) {
  if (view.requestFocus()) {
      val imm: InputMethodManager =
      context.getSystemService(Context.INPUT_METHOD_SERVICE) as 
InputMethodManager
     imm.showSoftInput(view, InputMethodManager.SHOW_IMPLICIT)
   }
}

  2. Hide Soft Keyboard

    fun Any.hideSoftKeyboard(view: View, context: Context) {
      val imm =
      context.getSystemService(Context.INPUT_METHOD_SERVICE) as 
InputMethodManager
    imm.hideSoftInputFromWindow(view.windowToken, 0)
}

You can use these methods in any Object Class to access these globally or you can make separate Extensions/CommonUtils Files for these.

Upvotes: 1

FABiO
FABiO

Reputation: 92

You can use a Function Extension in Kotlin. Replace activity by fragment if you need make it in Fragment.

fun Activity.hideKeyboard() {
    hideKeyboard(currentFocus ?: View(this))
}

Upvotes: 0

Yilmaz
Yilmaz

Reputation: 49749

Write a function to hide the keyboard:

private fun hideKeyboard(){
        // since our app extends AppCompatActivity, it has access to context
        val imm=getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
        // we have to tell hide the keyboard from what. inorder to do is we have to pass window token
        // all of our views,like message, name, button have access to same window token. since u have button
        imm.hideSoftInputFromWindow(button.windowToken, 0)

       // if you are using binding object
       // imm.hideSoftInputFromWindow(binding.button.windowToken,0)

    }

You have to call this function whereever u need

Upvotes: 2

MeLean
MeLean

Reputation: 3451

I didn't see this variant of Kotlin extension function:

fun View.hideSoftInput() {
    val inputMethodManager = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    inputMethodManager.hideSoftInputFromWindow(windowToken, 0)
}

Its benefit is that this extension function could be called from every CustomView and in every click or touch listener

Upvotes: 8

MRazaImtiaz
MRazaImtiaz

Reputation: 2187

Although there are many answers but this answer is related to a best practice in KOTLIN by opening and closing the keyboard with life cycle and extension function.

1). Create Extension Functions create a file EditTextExtension.kt and paste the below code

fun EditText.showKeyboard(
 ) {
  requestFocus()
  val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as 
  InputMethodManager
  imm.showSoftInput(this, InputMethodManager.SHOW_IMPLICIT)
 }

fun EditText.hideKeyboard(
) {
 val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as 
 InputMethodManager
 imm.hideSoftInputFromWindow(this.windowToken, 0)
 }

2). Create LifeCycleObserver Class Create a class EditTextKeyboardLifecycleObserver.kt and paste the code below

class EditTextKeyboardLifecycleObserver(
 private val editText: WeakReference<EditText>
 ) :
 LifecycleObserver {

 @OnLifecycleEvent(
     Lifecycle.Event.ON_RESUME
 )
 fun openKeyboard() {
     editText.get()?.postDelayed({ editText.get()?.showKeyboard() }, 50)
 }
 fun hideKeyboard() {
     editText.get()?.postDelayed({ editText.get()?.hideKeyboard() }, 50)
 }
}

3). Then use the below code in onViewCreated / onCreateView

lifecycle.addObserver(
         EditTextKeyboardLifecycleObserver(
             WeakReference(mEditText) //mEditText is the object(EditText)
         )
     )

The Keyboard will open when the user opens the fragment or activity.

if you occur any problems, following the solution feel free to ask in the comment.

Upvotes: 5

Peter Szucs
Peter Szucs

Reputation: 1146

I think we can improve Viktor's answer a little. Based on it always being attached to a View, there will be context, and if there is context then there is InputMethodManager:

fun View.hideKeyboard() {
    val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    imm.hideSoftInputFromWindow(windowToken, 0)
}

In this case the context automatically means the context of the view. What do you think?

Upvotes: 91

Chienmin Lee
Chienmin Lee

Reputation: 1

Kotlin I use bellow code:

import splitties.systemservices.inputMethodManager

inputMethodManager.hideSoftInputFromWindow(view?.windowToken, 0)

Upvotes: 0

Gunhan
Gunhan

Reputation: 7045

Use the following utility functions within your Activities, Fragments to hide the soft keyboard.

(*)Update for the latest Kotlin version

fun Fragment.hideKeyboard() {
    view?.let { activity?.hideKeyboard(it) }
}

fun Activity.hideKeyboard() {
    hideKeyboard(currentFocus ?: View(this))
}

fun Context.hideKeyboard(view: View) {
    val inputMethodManager = getSystemService(Activity.INPUT_METHOD_SERVICE) as InputMethodManager
    inputMethodManager.hideSoftInputFromWindow(view.windowToken, 0)
}

This will close the keyboard regardless of your code either in dialog fragment and/or activity etc.

Usage in Activity/Fragment:

hideKeyboard()

Upvotes: 230

Georgy Ivanov
Georgy Ivanov

Reputation: 35

Here is my solution in Kotlin for Fragment. Place it inside setOnClickListener of the button.

val imm = context?.getSystemService(Activity.INPUT_METHOD_SERVICE) as InputMethodManager?
imm?.toggleSoftInput(InputMethodManager.HIDE_IMPLICIT_ONLY, 0)

Upvotes: 4

Zeeshan Ayaz
Zeeshan Ayaz

Reputation: 1038

Simply override this method in your activity. It will automatically works in its child fragments as well.....

In JAVA

@Override
public boolean dispatchTouchEvent(MotionEvent ev) {
    if (getCurrentFocus() != null) {
        InputMethodManager imm = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
        imm.hideSoftInputFromWindow(getCurrentFocus().getWindowToken(), 0);
    }
    return super.dispatchTouchEvent(ev);
}

In Kotlin

override fun dispatchTouchEvent(ev: MotionEvent?): Boolean {
        if (currentFocus != null) {
            val imm = getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
            imm.hideSoftInputFromWindow(currentFocus!!.windowToken, 0)
        }
        return super.dispatchTouchEvent(ev)
    }

Upvotes: 25

Akbolat SSS
Akbolat SSS

Reputation: 2081

Thanks to @Zeeshan Ayaz Here is a little improved version

Because 'currentFocus' is nullable we better check it using Kotlin's ?.let

override fun dispatchTouchEvent(ev: MotionEvent?): Boolean {
    currentFocus?.let { currFocus ->
        val imm = getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
        imm.hideSoftInputFromWindow(currFocus.windowToken, 0)
    }
    return super.dispatchTouchEvent(ev)
}

Upvotes: 1

Seddiq Sorush
Seddiq Sorush

Reputation: 3152

In your Activity or Fragment create a function as:

fun View.hideKeyboard() {
 val inputManager = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
      inputManager.hideSoftInputFromWindow(windowToken, 0)
}

suppose you have a button with an id your_button_id in XML file related to this Activity or Fragment, so, on button click event:

    your_button_id.setOnClickListener{
       it.hideKeyboard()
     }

Upvotes: 15

Paulami Biswas
Paulami Biswas

Reputation: 173

Make an object class named Utils:

object Utils {

    fun hideSoftKeyBoard(context: Context, view: View) {
        try {
            val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
            imm?.hideSoftInputFromWindow(view.windowToken, InputMethodManager.HIDE_NOT_ALWAYS)
        } catch (e: Exception) {
            // TODO: handle exception
            e.printStackTrace()
        }

    }
}

You can use this method in any class where you want to hide the soft input keyboard. I am using this in my BaseActivity.

Here the view is any view that you use in your layout:

Utils.hideSoftKeyBoard(this@BaseActivity, view )

Upvotes: 6

jo jo
jo jo

Reputation: 1838

You can use from bellow code, I write bellow code in my fragment:

private val myLayout = ViewTreeObserver.OnGlobalLayoutListener {
    yourTextView.isCursorVisible = KeyboardTool.isSoftKeyboardShown(myRelativeLayout.rootView)
}

Then in onViewCreated of fragment:

......
super.onViewCreated(view, savedInstanceState)
myRelativeLayout.viewTreeObserver.addOnGlobalLayoutListener(myLayout)
......

And in onDestroyView use too:

override fun onDestroyView() {
    super.onDestroyView()
 myRelativeLayout.viewTreeObserver.removeOnGlobalLayoutListener(myLayout)
}

And:

object KeyboardTool {
    fun isSoftKeyboardShown(rootView: View): Boolean {
        val softKeyboardHeight = 100
        val rect = Rect()

        rootView.getWindowVisibleDisplayFrame(rect)

        val dm = rootView.resources.displayMetrics
        val heightDiff = rootView.bottom - rect.bottom
        return heightDiff > softKeyboardHeight * dm.density
    }
}

Upvotes: 0

Scooter
Scooter

Reputation: 4166

I found the answer that worked for me here: http://programminget.blogspot.com/2017/08/how-to-close-android-soft-keyboard.html 

val inputManager:InputMethodManager = getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
inputManager.hideSoftInputFromWindow(currentFocus.windowToken, InputMethodManager.SHOW_FORCED)

Upvotes: 4

Kavin Varnan
Kavin Varnan

Reputation: 1989

This works well with API 26. 

val view: View = if (currentFocus == null) View(this) else currentFocus
val inputMethodManager = getSystemService(Activity.INPUT_METHOD_SERVICE) as InputMethodManager
inputMethodManager.hideSoftInputFromWindow(view.windowToken, 0)

Upvotes: 2

michal.z
michal.z

Reputation: 2075

Peter's solution solves neatly the problem by extending functionality of View class. Alternative approach could be to extend functionality of Activity class and thus bind operation of hiding keyboard with View's container rather than View itself.

fun Activity.hideKeyboard() {
    val imm = getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    imm.hideSoftInputFromWindow(findViewById(android.R.id.content).getWindowToken(), 0);
}

Upvotes: 8

Viktor Yakunin
Viktor Yakunin

Reputation: 3296

You can use Anko to make life easier, so the line would be:

inputMethodManager.hideSoftInputFromWindow(view.windowToken, 0)

or maybe better to create extension function:

fun View.hideKeyboard(inputMethodManager: InputMethodManager) {
    inputMethodManager.hideSoftInputFromWindow(windowToken, 0)
}

and call it like this:

view?.hideKeyboard(activity.inputMethodManager)

Upvotes: 5

Related Questions