Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x-slayer/flutter_overlay_window
Flutter plugin for displaying flutter app over other apps on the screen
https://github.com/x-slayer/flutter_overlay_window
android android-overlays display-over-other-apps flutter flutter-overlay flutter-plugin overlay overlay-window truecaller
Last synced: 2 days ago
JSON representation
Flutter plugin for displaying flutter app over other apps on the screen
- Host: GitHub
- URL: https://github.com/x-slayer/flutter_overlay_window
- Owner: X-SLAYER
- License: mit
- Created: 2022-04-27T18:50:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T07:48:08.000Z (6 months ago)
- Last Synced: 2024-12-18T10:41:29.714Z (30 days ago)
- Topics: android, android-overlays, display-over-other-apps, flutter, flutter-overlay, flutter-plugin, overlay, overlay-window, truecaller
- Language: Dart
- Homepage: https://pub.dev/packages/flutter_overlay_window
- Size: 165 KB
- Stars: 114
- Watchers: 3
- Forks: 122
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Flutter plugin for displaying your Flutter app over other apps on the screen
---
## Preview
| TrueCaller overlay example | click-through overlay example | Messanger chat-head example |
| :------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: |
| 
| 
| 
|
## Installation
Add package to your pubspec:
```yaml
dependencies:
flutter_overlay_window: any # or the latest version on Pub
```
### Android
You'll need to add the `SYSTEM_ALERT_WINDOW` permission and `OverlayService` to your Android Manifest.
Replace `explanation_for_special_use` with your custom explanation.
```XML
...
```
### Entry point
Inside `main.dart` create an entry point for your Overlay widget;
```dart
// overlay entry point
@pragma("vm:entry-point")
void overlayMain() {
runApp(const MaterialApp(
debugShowCheckedModeBanner: false,
home: Material(child: Text("My overlay"))
));
}
```
### USAGE
```dart
/// check if overlay permission is granted
final bool status = await FlutterOverlayWindow.isPermissionGranted();
/// request overlay permission
/// it will open the overlay settings page and return `true` once the permission granted.
final bool status = await FlutterOverlayWindow.requestPermission();
/// Open overLay content
///
/// - Optional arguments:
///
/// `height` the overlay height and default is [WindowSize.fullCover]
///
/// `width` the overlay width and default is [WindowSize.matchParent]
///
/// `alignment` the alignment postion on screen and default is [OverlayAlignment.center]
///
/// `visibilitySecret` the detail displayed in notifications on the lock screen and default is [NotificationVisibility.visibilitySecret]
///
/// `OverlayFlag` the overlay flag and default is [OverlayFlag.defaultFlag]
///
/// `overlayTitle` the notification message and default is "overlay activated"
///
/// `overlayContent` the notification message
///
/// `enableDrag` to enable/disable dragging the overlay over the screen and default is "false"
///
/// `positionGravity` the overlay postion after drag and default is [PositionGravity.none]
///
/// `startPosition` the overlay start position and default is null
await FlutterOverlayWindow.showOverlay();
/// closes overlay if open
await FlutterOverlayWindow.closeOverlay();
/// broadcast data to and from overlay app
await FlutterOverlayWindow.shareData("Hello from the other side");
/// streams message shared between overlay and main app
FlutterOverlayWindow.overlayListener.listen((event) {
log("Current Event: $event");
});
/// use [OverlayFlag.focusPointer] when you want to use fields that show keyboards
await FlutterOverlayWindow.showOverlay(flag: OverlayFlag.focusPointer);
/// update the overlay flag while the overlay in action
await FlutterOverlayWindow.updateFlag(OverlayFlag.defaultFlag);
/// Update the overlay size in the screen
await FlutterOverlayWindow.resizeOverlay(80, 120);
/// Update the overlay position in the screen
///
/// `position` the new position of the overlay
///
/// `return` true if the position updated successfully
await FlutterOverlayWindow.moveOverlay(OverlayPosition(0, 156))
/// Get the current overlay position
///
/// `return` the current overlay position
await FlutterOverlayWindow.getOverlayPosition()
```
```dart
enum OverlayFlag {
/// Window flag: this window can never receive touch events.
/// Usefull if you want to display click-through overlay
clickThrough,
/// Window flag: this window won't ever get key input focus
/// so the user can not send key or other button events to it.
defaultFlag,
/// Window flag: allow any pointer events outside of the window to be sent to the windows behind it.
/// Usefull when you want to use fields that show keyboards.
focusPointer,
}
```
```dart
/// Type of dragging behavior for the overlay.
enum PositionGravity {
/// The `PositionGravity.none` will allow the overlay to postioned anywhere on the screen.
none,
/// The `PositionGravity.right` will allow the overlay to stick on the right side of the screen.
right,
/// The `PositionGravity.left` will allow the overlay to stick on the left side of the screen.
left,
/// The `PositionGravity.auto` will allow the overlay to stick either on the left or right side of the screen depending on the overlay position.
auto,
}
```