This commit is contained in:
Hamza-Ayed
2024-07-31 21:19:19 +03:00
parent dea83d970c
commit 2bc71355c3
106 changed files with 4600 additions and 727 deletions

29
flutter_overlay_apps-main/.gitignore vendored Normal file
View File

@@ -0,0 +1,29 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
# IntelliJ related
*.iml
*.ipr
*.iws
.idea/
# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/
# Flutter/Dart/Pub related
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
/pubspec.lock
**/doc/api/
.dart_tool/
.packages
build/

View File

@@ -0,0 +1,10 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.
version:
revision: b101bfe32f634566e7cb2791a9efe19cf8828b15
channel: beta
project_type: plugin

View File

@@ -0,0 +1,20 @@
## 1.2.0
* Upgraded gradle
* Added Back Button navigation action
## 1.1.2
* exposed overlay StreamController
## 1.0.2
* enabled keyboard input
## 1.0.1
* Update app from overlay fix
## 1.0.0
* Ininial release

View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022, Eddie Genius
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -0,0 +1,179 @@
# flutter_overlay_apps
Android plugin for displaying flutter app over other apps
## Usage
Add dependency to pubspec.yaml file
### Android
You'll need to add the `SYSTEM_ALERT_WINDOW` permission and `OverlayService` to your Android Manifest.
```XML
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
<application>
...
<service
android:name="com.phan_tech.flutter_overlay_apps.OverlayService"
android:exported="false" />
</application>
```
### Entry point
Inside `main.dart` create an entry point for your Overlay widget;
NOTE: `MaterialApp` is required
```dart
// overlay entry point
@pragma("vm:entry-point")
void showOverlay() {
runApp(const MaterialApp(
debugShowCheckedModeBanner: false,
home: Material(child: Text("My overlay"))
));
}
```
### Methods
To open an overlay, call `FlutterOverlayApps.showOverlay()`.
Default `height` & `width` is fill screen
```dart
FlutterOverlayApps.showOverlay(height: 300, width: 400, alignment: OverlayAlignment.center);
```
To close the overlay widget call
```dart
FlutterOverlayApps.closeOverlay();
```
To send data to and from Overlay widget, call
```dart
FlutterOverlayApps.sendDataToAndFromOverlay(<data>);
```
For listening to broadcasted data, stream the messages by calling
```dart
FlutterOverlayApps.overlayListener().listen((data) {
print(data);
});
```
### Code Example
```dart
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:flutter_overlay_apps/flutter_overlay_apps.dart';
void main() {
runApp(const MyApp());
}
// overlay entry point
@pragma("vm:entry-point")
void showOverlay() {
runApp(const MaterialApp(
debugShowCheckedModeBanner: false,
home: MyOverlaContent()
));
}
class MyApp extends StatelessWidget {
const MyApp({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('Plugin example app'),
),
body: Center(
child: ElevatedButton(
onPressed: () async {
// Open overlay
await FlutterOverlayApps.showOverlay(height: 300, width: 400, alignment: OverlayAlignment.center);
// send data to ovelay
await Future.delayed(const Duration(seconds: 2));
FlutterOverlayApps.sendDataToAndFromOverlay("Hello from main app");
},
child: const Text("showOverlay")
),
),
),
);
}
}
class MyOverlaContent extends StatefulWidget {
const MyOverlaContent({ Key? key }) : super(key: key);
@override
State<MyOverlaContent> createState() => _MyOverlaContentState();
}
class _MyOverlaContentState extends State<MyOverlaContent> {
String _dataFromApp = "Hey send data";
@override
void initState() {
super.initState();
// lisent for any data from the main app
FlutterOverlayApps.overlayListener().listen((event) {
setState(() {
_dataFromApp = event.toString();
});
});
}
@override
Widget build(BuildContext context) {
return Material(
child: InkWell(
onTap: (){
// close overlay
FlutterOverlayApps.closeOverlay();
},
child: Card(
shape: RoundedRectangleBorder(
borderRadius: BorderRadius.circular(16),
),
child: Center(child: Text(_dataFromApp, style: const TextStyle(color: Colors.red),)),
),
),
);
}
}
```
## Android back button
The back navigation button on android will close the overlay app. To prevent this, set `closeOnBackButton` to `false`. Example;
```dart
await FlutterOverlayApps.showOverlay(
height: 300,
closeOnBackButton: false,
alignment: OverlayAlignment.center);
```
When `closeOnBackButton` is set to `false`, an action will be sent via the stream controller. You can get the action like the example below;
```dart
var overlayStreamController = FlutterOverlayApps.overlayListener();
overlayStreamController.stream.listen((event) {
if(event['method'] == 'backButton'){
// handle back button
if(mounted && Navigator.of(context).canPop()){
Navigator.of(context).pop();
}
}
})
```
Support the plugin <a href="https://www.buymeacoffee.com/EddieGenius" target="_blank"><img src="https://i.imgur.com/aV6DDA7.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important; box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" > </a>

View File

@@ -0,0 +1,4 @@
include: package:flutter_lints/flutter.yaml
# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options

View File

@@ -0,0 +1,9 @@
*.iml
.gradle
/local.properties
/.idea/workspace.xml
/.idea/libraries
.DS_Store
/build
/captures
.cxx

View File

@@ -0,0 +1,52 @@
group 'com.phan_tech.flutter_overlay_apps'
version '1.0-SNAPSHOT'
buildscript {
ext.kotlin_version = '1.6.10'
repositories {
google()
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:4.1.0'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}
}
rootProject.allprojects {
repositories {
google()
mavenCentral()
}
}
apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
android {
compileSdkVersion 31
namespace 'com.phan_tech.flutter_overlay_apps' // Specify the namespace here
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = '1.8'
}
sourceSets {
main.java.srcDirs += 'src/main/kotlin'
}
defaultConfig {
minSdkVersion 16
}
}
dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
}

Binary file not shown.

View File

@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

234
flutter_overlay_apps-main/android/gradlew vendored Executable file
View File

@@ -0,0 +1,234 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
APP_NAME="Gradle"
APP_BASE_NAME=${0##*/}
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

View File

@@ -0,0 +1,89 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

View File

@@ -0,0 +1 @@
rootProject.name = 'flutter_overlay_apps'

View File

@@ -0,0 +1,4 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.phan_tech.flutter_overlay_apps"
>
</manifest>

View File

@@ -0,0 +1,131 @@
package com.phan_tech.flutter_overlay_apps
import android.app.Activity
import android.content.Context
import android.content.Intent
import android.net.Uri
import android.os.Build
import android.provider.Settings
import androidx.annotation.NonNull
import androidx.annotation.RequiresApi
import io.flutter.FlutterInjector
import io.flutter.embedding.engine.FlutterEngineCache
import io.flutter.embedding.engine.FlutterEngineGroup
import io.flutter.embedding.engine.dart.DartExecutor
import io.flutter.embedding.engine.plugins.FlutterPlugin
import io.flutter.embedding.engine.plugins.activity.ActivityAware
import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
import io.flutter.plugin.common.*
import io.flutter.plugin.common.MethodChannel.MethodCallHandler
import io.flutter.plugin.common.MethodChannel.Result
const val mainAppMethodChannel: String = "com.phan_tech/flutter_overlay_apps"
const val overlayAppMethodChannel: String = "com.phan_tech/flutter_overlay_apps/overlay"
const val overlayAppMessageChannel: String = "com.phan_tech/flutter_overlay_apps/overlay/messenger"
/** FlutterOverlayAppsPlugin */
class FlutterOverlayAppsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware, BasicMessageChannel.MessageHandler<Any?> {
private lateinit var channel: MethodChannel
private lateinit var messenger: BasicMessageChannel<Any?>
private lateinit var context: Context
private var activity: Activity? = null
override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) {
channel.setMethodCallHandler(null)
}
override fun onAttachedToActivity(binding: ActivityPluginBinding) {
activity = binding.activity
context = binding.activity.applicationContext
WindowSetup.messenger = messenger
WindowSetup.messenger!!.setMessageHandler(this)
val engineGroup = FlutterEngineGroup(context)
val dartEntrypoint = DartExecutor.DartEntrypoint(
FlutterInjector.instance().flutterLoader().findAppBundlePath(),
"showOverlay"
)
val engine = engineGroup.createAndRunEngine(context, dartEntrypoint)
FlutterEngineCache.getInstance().put("my_engine_id", engine)
}
override fun onDetachedFromActivityForConfigChanges() {
activity = null
}
override fun onReattachedToActivityForConfigChanges(binding: ActivityPluginBinding) {
activity = binding.activity
}
override fun onDetachedFromActivity() {
activity = null
}
override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
channel = MethodChannel(flutterPluginBinding.binaryMessenger, mainAppMethodChannel)
channel.setMethodCallHandler(this)
messenger = BasicMessageChannel(flutterPluginBinding.binaryMessenger, overlayAppMessageChannel, JSONMessageCodec.INSTANCE)
messenger.setMessageHandler(this)
}
override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
val currentActivity = activity
if (currentActivity == null) {
result.error("activity_not_attached", "Activity is not attached", null)
return
}
when (call.method) {
"showOverlay" -> {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.M) {
result.error("1", "SDK version is lower than 23", "Requires Android SDK 23 and above")
} else if (!checkPermissions()) {
requestPermissions()
} else {
val height = call.argument<Int>("height")
val width = call.argument<Int>("width")
val alignment = call.argument<String>("alignment")
val closeOnBackButton = call.argument<Boolean>("closeOnBackButton")
WindowSetup.width = width ?: -1
WindowSetup.height = height ?: -1
WindowSetup.closeOnBackButton = closeOnBackButton ?: true
WindowSetup.setGravityFromAlignment(alignment ?: "center")
currentActivity.startService(Intent(context, OverlayService::class.java))
result.success(true)
}
}
else -> {
result.notImplemented()
}
}
}
override fun onMessage(message: Any?, reply: BasicMessageChannel.Reply<Any?>) {
val engine = FlutterEngineCache.getInstance().get("my_engine_id")
if (engine != null) {
val overlayMessageChannel = BasicMessageChannel(engine.dartExecutor, overlayAppMessageChannel, JSONMessageCodec.INSTANCE)
overlayMessageChannel.send(message, reply)
} else {
reply.reply(null)
}
}
@RequiresApi(Build.VERSION_CODES.M)
private fun checkPermissions(): Boolean {
return Settings.canDrawOverlays(context)
}
@RequiresApi(Build.VERSION_CODES.M)
private fun requestPermissions() {
activity?.let {
it.startActivity(
Intent(
Settings.ACTION_MANAGE_OVERLAY_PERMISSION,
Uri.parse("package:${it.packageName}")
)
)
}
}
}

View File

@@ -0,0 +1,97 @@
package com.phan_tech.flutter_overlay_apps
import android.app.Service
import android.content.Intent
import android.graphics.PixelFormat
import android.os.Build
import android.os.IBinder
import android.view.KeyEvent
import android.view.WindowManager
import android.widget.FrameLayout
import androidx.annotation.RequiresApi
import io.flutter.embedding.android.FlutterView
import io.flutter.embedding.engine.FlutterEngineCache
import io.flutter.plugin.common.BasicMessageChannel
import io.flutter.plugin.common.JSONMessageCodec
import io.flutter.plugin.common.MethodCall
import io.flutter.plugin.common.MethodChannel
import org.json.JSONObject
class OverlayService : Service() {
private var windowManager: WindowManager? = null
private lateinit var flutterView: FlutterView
private val flutterChannel = MethodChannel(FlutterEngineCache.getInstance().get("my_engine_id")!!.dartExecutor, overlayAppMethodChannel)
private val overlayMessageChannel = BasicMessageChannel(FlutterEngineCache.getInstance().get("my_engine_id")!!.dartExecutor, overlayAppMessageChannel, JSONMessageCodec.INSTANCE)
override fun onBind(intent: Intent?): IBinder? {
// Not used
return null
}
@RequiresApi(Build.VERSION_CODES.O)
override fun onCreate() {
super.onCreate()
val engine = FlutterEngineCache.getInstance().get("my_engine_id")!!
engine.lifecycleChannel.appIsResumed()
flutterView = object: FlutterView(applicationContext){
override fun dispatchKeyEvent(event: KeyEvent): Boolean {
return if (event.keyCode == KeyEvent.KEYCODE_BACK) {
// handle the back button code;
if(WindowSetup.closeOnBackButton){
stopService(Intent(baseContext, OverlayService().javaClass))
windowManager?.removeView(flutterView)
}else{
// send message
overlayMessageChannel.send(JSONObject("{\"method\": \"backButton\"}"))// {"method" "backButton"}
}
true
} else super.dispatchKeyEvent(event)
}
}
flutterView.attachToFlutterEngine(FlutterEngineCache.getInstance().get("my_engine_id")!!)
flutterView.fitsSystemWindows = true
flutterChannel.setMethodCallHandler{ methodCall: MethodCall, result: MethodChannel.Result ->
if(methodCall.method == "close"){
val closed = stopService(Intent(baseContext, OverlayService().javaClass))
result.success(closed)
}
}
overlayMessageChannel.setMessageHandler(MyHandler())
windowManager = getSystemService(WINDOW_SERVICE) as WindowManager?
val params = WindowManager.LayoutParams(
WindowSetup.width,
WindowSetup.height,
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY
else WindowManager.LayoutParams.TYPE_SYSTEM_OVERLAY,
WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE,
PixelFormat.TRANSLUCENT
)
params.flags = params.flags and WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE.inv()
params.gravity = WindowSetup.gravity
windowManager!!.addView(flutterView, params)
}
override fun onDestroy() {
super.onDestroy()
windowManager!!.removeView(flutterView)
}
}
class MyHandler: BasicMessageChannel.MessageHandler<Any?>{
override fun onMessage(message: Any?, reply: BasicMessageChannel.Reply<Any?>) {
WindowSetup.messenger!!.send(message)
}
}

View File

@@ -0,0 +1,53 @@
package com.phan_tech.flutter_overlay_apps
import android.annotation.SuppressLint
import android.view.Gravity
import android.view.WindowManager
import io.flutter.plugin.common.BasicMessageChannel
object WindowSetup {
var height: Int = -1
var width: Int = WindowManager.LayoutParams.MATCH_PARENT
var gravity: Int = Gravity.CENTER
var messenger : BasicMessageChannel<Any?>? = null
var closeOnBackButton : Boolean = true;
@SuppressLint("RtlHardcoded")
fun setGravityFromAlignment(alignment: String){
when {
alignment.lowercase() == "topLeft".lowercase() -> {
gravity = Gravity.TOP or Gravity.LEFT
}
alignment.lowercase() == "topCenter".lowercase() -> {
gravity = Gravity.TOP
}
alignment.lowercase() == "topRight".lowercase() -> {
gravity = Gravity.TOP or Gravity.RIGHT
}
alignment.lowercase() == "centerLeft".lowercase() -> {
gravity = Gravity.CENTER or Gravity.LEFT
}
alignment.lowercase() == "center".lowercase() -> {
gravity = Gravity.CENTER
}
alignment.lowercase() == "centerRight".lowercase() -> {
gravity = Gravity.CENTER or Gravity.RIGHT
}
alignment.lowercase() == "bottomLeft".lowercase() -> {
gravity = Gravity.BOTTOM or Gravity.LEFT
}
alignment.lowercase() == "bottomCenter".lowercase() -> {
gravity = Gravity.BOTTOM
}
alignment.lowercase() == "bottomRight".lowercase() -> {
gravity = Gravity.BOTTOM or Gravity.RIGHT
}
}
}
}

View File

@@ -0,0 +1,84 @@
import 'dart:async';
import 'package:flutter/services.dart';
const int overlaySizeFill = -1;
const String _mainAppMethodChannel = "com.phan_tech./flutter_overlay_apps";
const String _overlayAppMethodChannel =
"com.phan_tech/flutter_overlay_apps/overlay";
const String _overlayAppMessageChannel =
"com.phan_tech/flutter_overlay_apps/overlay/messenger";
class FlutterOverlayApps {
static const MethodChannel _channel = MethodChannel(_mainAppMethodChannel);
// overlay methodChanel
static const MethodChannel _overlayChannel =
MethodChannel(_overlayAppMethodChannel);
//Overlay BasicMessageChannel
static const BasicMessageChannel _overlayMessageChannel =
BasicMessageChannel(_overlayAppMessageChannel, JSONMessageCodec());
/// Open overLay content
/// Takes optional;
/// - int [height] default is [overlaySizeFill]
/// - int [width] default is [overlaySizeFill]
/// - OverlayAlignment [width] default is [alignment] [OverlayAlignment.center]
/// - bool [closeOnBackButton] default is `true`
static Future<bool?> showOverlay(
{int height = overlaySizeFill,
int width = overlaySizeFill,
bool closeOnBackButton = true,
OverlayAlignment alignment = OverlayAlignment.center}) async {
final bool? _res = await _channel.invokeMethod('showOverlay', {
"height": height,
"width": width,
"alignment": alignment.name,
"closeOnBackButton": closeOnBackButton
});
return _res;
}
/// Closes overlau if open
static Future<bool?> closeOverlay() async {
final bool? _res = await _overlayChannel.invokeMethod('close');
return _res;
}
/// broadcast data to and from overlay app
/// the supported data type are;
/// - [int], [double], [bool], [String], null
/// - [List] of supported types
/// - [Map] of supported types
static Future sendDataToAndFromOverlay(dynamic data) async {
return await _overlayMessageChannel.send(data);
}
/// Streams message shared between overlay and main app
static final StreamController _controller = StreamController();
static StreamController overlayListener() {
_overlayMessageChannel.setMessageHandler((message) async {
_controller.add(message);
return message;
});
return _controller;
}
/// dispose overlay controller
static void disposeOverlayListener() {
_controller.close();
}
}
/// Overlay alignment on screen
enum OverlayAlignment {
topLeft,
topCenter,
topRight,
centerLeft,
center,
centerRight,
bottomLeft,
bottomCenter,
bottomRight
}

View File

@@ -0,0 +1,27 @@
name: flutter_overlay_apps
description: Android plugin for displaying flutter widgets over other apps
version: 1.2.0
homepage: https://github.com/EddieKamau/flutter_overlay_apps
environment:
sdk: ">=2.16.0 <4.0.0"
flutter: ">=2.5.0"
dependencies:
flutter:
sdk: flutter
dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^1.0.0
flutter:
plugin:
platforms:
android:
package: com.phan_tech.flutter_overlay_apps
pluginClass: FlutterOverlayAppsPlugin

View File

@@ -0,0 +1,24 @@
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:flutter_overlay_apps/flutter_overlay_apps.dart';
void main() {
const MethodChannel channel =
MethodChannel('com.phan_tech./flutter_overlay_apps');
TestWidgetsFlutterBinding.ensureInitialized();
setUp(() {
channel.setMockMethodCallHandler((MethodCall methodCall) async {
return true;
});
});
tearDown(() {
channel.setMockMethodCallHandler(null);
});
test('getPlatformVersion', () async {
expect(await FlutterOverlayApps.showOverlay(), true);
});
}