PanelHelper

The PanelHelper is a helper class to perform operations related to overlays over the keyboard.

There are two types of panels:

  • Frame view panel: An overlay anchored to the bottom of the predictions bar with variable height.
  • Full view panel: An overlay anchored between the top of the frame view panel and the bottom of the keyboard.

Panel Helper

Notes:

  • The frame view and full view will be added as a child of a FrameLayout.
  • The frame view and full view contents will be clipped.
  • The frame view will push the contents of the application above it.
  • The views will remain visible when changing editors (input fields).
  • The views will be only added after the input view has been created (see android documentation for onCreateInputView). The operation will be silently discarded if added before the input view is created.
showFrameView Sets and displays the frame view
hideFrameView Hides the frame view
showFullView Sets and displays the full view
hideFullView Hides the full view
openApp Open an app

ShowFrameView

Replaces the contents of the frame view with the provided view and makes it visible.

fun showFrameView(view: View)

HideFrameView

Removes the contents of the frame view and makes it hidden.

Notes:

  • This won’t hide the full view if it was visible and the size of the full view will adjust to the new available size.
fun hideFrameView()

ShowFullView

Replaces the contents of the full view with the provided view and makes it visible

fun showFullView(view: View)

HideFullView

Removes the contents of the full view and makes it hidden.

Notes:

  • This won’t hide the frame view if it was visible.
fun hideFullView()

OpenApp

Requests a registered app in the AppsConfiguration to open via its app identifier.

Notes:

  • This will hide any panel that was opened via showFrameView or showFullView.
fun openApp(appId: String)

Last updated on September 9, 2022