flutter_custom_overlay 0.2.1 copy "flutter_custom_overlay: ^0.2.1" to clipboard
flutter_custom_overlay: ^0.2.1 copied to clipboard

PlatformAndroid

A Flutter plugin for creating customizable overlay windows on Android with bidirectional data communication and dynamic control.

Changelog #

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.2.1 - 2026-01-13 #

Fixed #

  • Updated README documentation to use correct pub.dev dependency syntax.

Added #

  • Overlay Alignment: New OverlayAlignment enum (center, topLeft, etc.) in OverlayConfig for easy positioning.
  • Data Passing: showOverlay(data: ...) now accepts initial data to be sent immediately to the overlay.
  • Visibility Check: Added isOverlayVisible() to check if the overlay window is currently on screen.
  • Reset on Hide: Added hideAndRestartOverlay() to hide the window and reset the engine state (optimized with deferred restart).
  • Transparency Fix: Switched to FlutterTextureView to resolve background frame issues, ensuring true transparency.

Changed #

  • Breaking: OverlayConfig.gravity (String) replaced with OverlayConfig.alignment (OverlayAlignment enum).
  • Breaking: Removed manual initializeOverlay() and entryPoint parameter in showOverlay. The overlay now auto-initializes using @pragma('vm:entry-point') void overlayMain().
  • hideOverlay() now preserves the engine state (keeps it running in background). Use hideAndRestartOverlay() for a full reset.

Added #

  • Initial release of Flutter Custom Overlay plugin
  • Support for custom Flutter overlay windows on Android
  • Bidirectional data communication between main app and overlay
  • Dynamic position and size control
  • Draggable overlay support
  • Permission management helpers
  • Configurable overlay properties (gravity, focusability, click-through)
  • Comprehensive example application
  • Full documentation and usage examples

Platform Support #

  • Android API 23+ (Android 6.0 Marshmallow and above)

Features #

  • showOverlay() - Display overlay with custom entry point and configuration
  • hideOverlay() - Hide/remove the overlay
  • updatePosition() - Dynamically adjust overlay position
  • updateSize() - Dynamically adjust overlay size
  • shareData() - Send data from main app to overlay
  • overlayStream - Receive data from overlay in main app
  • hasOverlayPermission() - Check overlay permission status
  • requestOverlayPermission() - Request overlay permission from user
  • isOverlayActive() - Check if overlay is currently displayed
0
likes
160
points
23
downloads

Publisher

unverified uploader

Weekly Downloads

A Flutter plugin for creating customizable overlay windows on Android with bidirectional data communication and dynamic control.

Homepage

Documentation

API reference

License

MIT (license)

Dependencies

flutter, plugin_platform_interface

More

Packages that depend on flutter_custom_overlay

Packages that implement flutter_custom_overlay