@maximilien0405/capacitor-android-launcher 7.0.2 → 7.0.4

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Maximilien Zimmermann
+
+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.

package/README.md

@@ -1,22 +1,26 @@
 # Capacitor Android Launcher Plugin
 
-This Capacitor plugin allows you to open the launcher settings to set your app as the default launcher on Android. 
+The Capacitor Android Launcher Plugin allows you to set your app as the default launcher on Android devices. 
 
-It can also, if needed, start (and stop) and immersive mode that hides the all UI elements (status bar and navigation bar). This is usefull for an Kiosk App, or for special apps made for childrens or seniors.
-
-> When set as the default launcher, your user will still be able to exit it, but when it happens it will re-open the app.
-If you really want to prevent your user from leaving, i suggest "pinning" the app, and then setting it as the default launcher. 
+It also provides immersive mode functionality, which hides all system UI elements (status bar and navigation bar). This can be useful for kiosk apps or even apps designed for children or seniors.
 
 ## Installation
 
+To install the plugin, run the following commands:
+
 ```bash
 npm install @maximilien0405/capacitor-android-launcher
 npx cap sync
 ```
 
+And import it just like this:
+```ts
+import { AndroidLauncher } from '@maximilien0405/capacitor-android-launcher';
+```
+
 ## Usage
 
-#### Open Launcher Settings
+### Open Launcher Settings
 
 This method opens the settings page where the user can set your app as the default launcher.
 
@@ -24,27 +28,39 @@ This method opens the settings page where the user can set your app as the defau
 await AndroidLauncher.openLauncherSettings();
 ```
 
-#### Start Immersive Mode
+### Start Immersive Mode
 
-This method hides all system controls. 
+This method hides all system UI elements, creating a full-screen experience.
 
 ```ts
 await AndroidLauncher.startImmersiveMode();
 ```
 
-#### Stop Immersive Mode
+### Stop Immersive Mode
 
-This method restores the system controls.
+This method restores the system UI elements.
 
 ```ts
 await AndroidLauncher.stopImmersiveMode();
 ```
 
-#### Check if is the Launcher
+### Check if App is the Default Launcher
 
 This method checks if your app is currently set as the default launcher.
 
 ```ts
 const isLauncher = await AndroidLauncher.isLauncherApp();
-console.log(isLauncher);  // true or false
-```
+console.log(isLauncher); // true or false
+```
+
+## Notes
+
+- When set as the default launcher, users can still exit the app. To prevent this, consider using Android's "pinning" feature in combination with this plugin.
+
+## Support
+
+For issues or feature requests, please open an issue on the [GitHub repository](https://github.com/maximilien0405/capacitor-android-launcher).
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.

package/android/src/main/java/com/maximilien0405/androidlauncher/AndroidLauncher.java

@@ -43,67 +43,58 @@ public class AndroidLauncher {
         }
     }
 
-    // Starts immersive mode
-    public void startImmersiveMode(PluginCall call) {
-        runOnMainThread(() -> {
-            try {
-                enableImmersiveMode();
-                call.resolve();
-            } catch (Exception e) {
-                call.reject("Error starting immersive mode", e);
-            }
-        });
-    }
-
-    private void enableImmersiveMode() {
-        immersiveModeEnabled = true;
-        setupSystemUiVisibilityListener();
+    private void setImmersiveMode(boolean enable) {
+        immersiveModeEnabled = enable;
         View decorView = this.bridge.getActivity().getWindow().getDecorView();
 
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
             WindowInsetsController insetsController = decorView.getWindowInsetsController();
             if (insetsController != null) {
-                insetsController.hide(WindowInsets.Type.statusBars() | WindowInsets.Type.navigationBars());
-                insetsController.setSystemBarsBehavior(WindowInsetsController.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE);
+                if (enable) {
+                    insetsController.hide(WindowInsets.Type.statusBars() | WindowInsets.Type.navigationBars());
+                    insetsController.setSystemBarsBehavior(WindowInsetsController.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE);
+                } else {
+                    insetsController.show(WindowInsets.Type.statusBars() | WindowInsets.Type.navigationBars());
+                    insetsController.setSystemBarsBehavior(WindowInsetsController.BEHAVIOR_SHOW_BARS_BY_TOUCH);
+                }
             }
         } else {
-            int flags = View.SYSTEM_UI_FLAG_LAYOUT_STABLE
+            int flags = enable
+                    ? View.SYSTEM_UI_FLAG_LAYOUT_STABLE
                     | View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
                     | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN
                     | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION
                     | View.SYSTEM_UI_FLAG_FULLSCREEN
-                    | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY;
+                    | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
+                    : View.SYSTEM_UI_FLAG_LAYOUT_STABLE;
             decorView.setSystemUiVisibility(flags);
         }
     }
 
-    // Stops immersive mode
-    public void stopImmersiveMode(PluginCall call) {
+    // Starts immersive mode
+    public void startImmersiveMode(PluginCall call) {
         runOnMainThread(() -> {
             try {
-                clearImmersiveMode();
+                setImmersiveMode(true);
+                setupSystemUiVisibilityListener();
                 call.resolve();
             } catch (Exception e) {
-                call.reject("Error stopping immersive mode", e);
+                call.reject("Error starting immersive mode", e);
             }
         });
     }
 
-    private void clearImmersiveMode() {
-        immersiveModeEnabled = false;
-        removeSystemUiVisibilityListener();
-        View decorView = this.bridge.getActivity().getWindow().getDecorView();
-
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
-            WindowInsetsController insetsController = decorView.getWindowInsetsController();
-            if (insetsController != null) {
-                insetsController.show(WindowInsets.Type.statusBars() | WindowInsets.Type.navigationBars());
-                insetsController.setSystemBarsBehavior(WindowInsetsController.BEHAVIOR_SHOW_BARS_BY_TOUCH);
+    // Stops immersive mode
+    public void stopImmersiveMode(PluginCall call) {
+        runOnMainThread(() -> {
+            try {
+                setImmersiveMode(false);
+                removeSystemUiVisibilityListener();
+                call.resolve();
+            } catch (Exception e) {
+                call.reject("Error stopping immersive mode", e);
             }
-        } else {
-            int flags = View.SYSTEM_UI_FLAG_LAYOUT_STABLE;
-            decorView.setSystemUiVisibility(flags);
-        }
+        });
     }
 
     // Helper to run things on the UI thread
@@ -132,14 +123,14 @@ public class AndroidLauncher {
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
             focusChangeListener = hasFocus -> {
                 if (immersiveModeEnabled && hasFocus) {
-                    enableImmersiveMode();
+                    setImmersiveMode(true);
                 }
             };
             decorView.getViewTreeObserver().addOnWindowFocusChangeListener(focusChangeListener);
         } else {
             systemUiVisibilityChangeListener = visibility -> {
                 if (immersiveModeEnabled && (visibility & View.SYSTEM_UI_FLAG_FULLSCREEN) == 0) {
-                    enableImmersiveMode();
+                    setImmersiveMode(true);
                 }
             };
             decorView.setOnSystemUiVisibilityChangeListener(systemUiVisibilityChangeListener);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maximilien0405/capacitor-android-launcher",
-  "version": "7.0.2",
+  "version": "7.0.4",
   "description": "Capacitor plugin to request your app to be the main launcher.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",