showOverlay method

Future<void> showOverlay({
  1. int? overlayHeightDp,
})

Shows the overlay UI.

This displays the custom Flutter UI that was registered with registerOverlayUi. The overlay typically appears with a slide-up animation from the bottom of the screen.

Parameters:

  • overlayHeightDp: Optional parameter to specify the height of the overlay in density-independent pixels. If not provided, a default height is used.

Implementations should override this method to show the overlay on the platform.

Implementation

Future<void> showOverlay({int? overlayHeightDp}) {
  throw UnimplementedError('showOverlay() has not been implemented.');
}