ソフトウェア キーボードを制御してアニメーション化する

Compose をお試しください
Jetpack Compose は、Android で推奨される UI ツールキットです。Compose でキーボードを操作する方法について説明します。
Compose のソフトウェア キーボード →

WindowInsetsCompat を使用すると、 システムバーを操作する場合と同様に、画面キーボード（ IME とも呼ばれます）のクエリと制御を行うことができます。また、 WindowInsetsAnimationCompat を使用して、ソフトウェア キーボードの開閉時にシームレスなトランジションを作成することもできます。

図 1. ソフトウェア キーボードの開閉トランジションの 2 つの例。

前提条件

ソフトウェア キーボードの制御とアニメーションを設定する前に、 アプリをエッジからエッジまで表示されるように構成します。これにより、システム ウィンドウ インセット（システムバーや画面キーボードなど）を処理できます。

キーボード ソフトウェアの表示設定を確認する

WindowInsets を使用して、ソフトウェア キーボードの表示設定を確認します。

Kotlin

val insets = ViewCompat.getRootWindowInsets(view) ?: return
val imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime())
val imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom

Java

WindowInsetsCompat insets = ViewCompat.getRootWindowInsets(view);
boolean imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime());
int imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom;

または、 ViewCompat.setOnApplyWindowInsetsListener を使用して、ソフトウェア キーボードの表示設定の変更を監視することもできます。

Kotlin

ViewCompat.setOnApplyWindowInsetsListener(view) { _, insets ->
  val imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime())
  val imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom
  insets
}

Java

ViewCompat.setOnApplyWindowInsetsListener(view, (v, insets) -> {
  boolean imeVisible = insets.isVisible(WindowInsetsCompat.Type.ime());
  int imeHeight = insets.getInsets(WindowInsetsCompat.Type.ime()).bottom;
  return insets;
});

アニメーションをソフトウェア キーボードと同期する

ユーザーがテキスト入力フィールドをタップすると、次の例に示すように、キーボードが画面の下部からスライドして表示されます。

図 2. キーボード アニメーションの同期。

  • 図 2 の「同期されていない」というラベルの例は、Android 10（API レベル 29）でのデフォルトの動作を示しています。この場合、テキスト フィールドとアプリのコンテンツは、キーボードのアニメーションと同期するのではなく、スナップして表示されます。この動作は視覚的に不自然に見えることがあります。

  • Android 11（API レベル 30）以降では、WindowInsetsAnimationCompat を使用して、アプリのトランジションをキーボードが画面の下部から上下にスライドする動作と同期させることができます。図 2 の「同期されている」というラベルの例に示すように、よりスムーズに表示されます。

キーボード アニメーションと同期するビューを使用して WindowInsetsAnimationCompat.Callback を構成します。

Kotlin

ViewCompat.setWindowInsetsAnimationCallback(
  view,
  object : WindowInsetsAnimationCompat.Callback(DISPATCH_MODE_STOP) {
    // Override methods.
  }
)

Java

ViewCompat.setWindowInsetsAnimationCallback(
    view,
    new WindowInsetsAnimationCompat.Callback(
        WindowInsetsAnimationCompat.Callback.DISPATCH_MODE_STOP
    ) {
      // Override methods.
    });

WindowInsetsAnimationCompat.Callback には、 たとえば onPrepare()、 onStart()、 onProgress()、 および onEnd() など、オーバーライドするメソッドがいくつかあります。 レイアウトを変更する前に、まず onPrepare() を呼び出します。

onPrepare は、インセット アニメーションが開始されるとき、およびアニメーションによってビューが再レイアウトされる前に呼び出されます。これを使用して、開始状態（この場合はビューの下部座標）を保存できます。

ルートビューの開始状態の下部座標を示す画像。
図 3.onPrepare() を使用して開始状態を記録する。

次のスニペットは、onPrepare の呼び出し例を示しています。

Kotlin

var startBottom = 0f

override fun onPrepare(
  animation: WindowInsetsAnimationCompat
) {
  startBottom = view.bottom.toFloat()
}

Java

float startBottom;

@Override
public void onPrepare(
    @NonNull WindowInsetsAnimationCompat animation
) {
  startBottom = view.getBottom();
}

onStart は、インセット アニメーションが開始されるときに呼び出されます。これを使用して、すべてのビュー プロパティをレイアウト変更の終了状態に設定できます。いずれかのビューに OnApplyWindowInsetsListener コールバックが設定されている場合は、この時点で呼び出されます。この時点で、ビュー プロパティの終了状態を保存することをおすすめします。

ビューの終了状態の下部座標を示す画像
図 4.onStart() を使用して終了状態を記録する。

次のスニペットは、onStart の呼び出し例を示しています。

Kotlin

var endBottom = 0f

override fun onStart(
  animation: WindowInsetsAnimationCompat,
  bounds: WindowInsetsAnimationCompat.BoundsCompat
): WindowInsetsAnimationCompat.BoundsCompat {
  // Record the position of the view after the IME transition.
  endBottom = view.bottom.toFloat()

  return bounds
}

Java

float endBottom;

@NonNull
@Override
public WindowInsetsAnimationCompat.BoundsCompat onStart(
    @NonNull WindowInsetsAnimationCompat animation,
    @NonNull WindowInsetsAnimationCompat.BoundsCompat bounds
) {
  endBottom = view.getBottom();
  return bounds;
}

onProgress は、アニメーションの実行中にインセットが変更されるときに呼び出されるため、オーバーライドして、キーボード アニメーションのすべてのフレームで通知を受け取ることができます。ビューがキーボードと同期してアニメーション化されるように、ビュー プロパティを更新します。

この時点で、すべてのレイアウト変更が完了しています。たとえば、View.translationY を使用してビューをシフトする場合、このメソッドが呼び出されるたびに値が徐々に減少し、最終的に 0 になって元のレイアウト位置に戻ります。

図 5. onProgress() を使用してアニメーションを同期する。

次のスニペットは、onProgress の呼び出し例を示しています。

Kotlin

override fun onProgress(
  insets: WindowInsetsCompat,
  runningAnimations: MutableList<WindowInsetsAnimationCompat>
): WindowInsetsCompat {
  // Find an IME animation.
  val imeAnimation = runningAnimations.find {
    it.typeMask and WindowInsetsCompat.Type.ime() != 0
  } ?: return insets

  // Offset the view based on the interpolated fraction of the IME animation.
  view.translationY =
    (startBottom - endBottom) * (1 - imeAnimation.interpolatedFraction)

  return insets
}

Java

@NonNull
@Override
public WindowInsetsCompat onProgress(
    @NonNull WindowInsetsCompat insets,
    @NonNull List<WindowInsetsAnimationCompat> runningAnimations
) {
  // Find an IME animation.
  WindowInsetsAnimationCompat imeAnimation = null;
  for (WindowInsetsAnimationCompat animation : runningAnimations) {
    if ((animation.getTypeMask() & WindowInsetsCompat.Type.ime()) != 0) {
      imeAnimation = animation;
      break;
    }
  }
  if (imeAnimation != null) {
    // Offset the view based on the interpolated fraction of the IME animation.
    view.setTranslationY((startBottom - endBottom)

        *   (1 - imeAnimation.getInterpolatedFraction()));
  }
  return insets;
}

必要に応じて、onEnd をオーバーライドできます。このメソッドは、アニメーションが終了した後に呼び出されます。この時点で、一時的な変更をクリーンアップすることをおすすめします。

参考情報