easy-immersive-mode

Easy Immersive Mode for CapacitorJS

Install

npm install easy-immersive-mode
npx cap sync

Quick intro

This plugin was developed for Android App with CapacitorJS. The plugin's main feature is immersive mode or full screen app.

📋️ Requirements

• capacitor/android 7.x.x
• capacitor/core 7.x.x

💻️ Quick example

The best way to add the plugin to CapacitorJS app (ex: Angular) is importing the plugin into component.

import { CommonModule } from '@angular/common';
import { Component } from '@angular/core';
import { EasyImmersiveMode as EIM } from 'easy-immersive-mode';

@Component({
  selector: 'app-root',
  imports: [CommonModule],
  templateUrl: './app.component.html',
  styleUrl: './app.component.css'
})
export class AppComponent {
  // It could be public or private method / function
  enableImmersiveMode(): void {
    EIM.enable().then(() => {
      console.log('Immersive mode enable');
    });
  }

  disableImmersiveMode():void {
    EIM.disable().then(() => {
      console.log('Immersive mode disabled');
    });
  }
}

API

• enable()
• disable()

enable()

enable() => Promise<void>

disable()

disable() => Promise<void>

📌 Showcase Example

A real example of an application using this plugin:

🔗 See the app

Contact, Reports or Bugs

Thanks for checking out the project. You can take a peek about my work by visiting my website.

🌍 Website: Visit