@capgo/home-indicator

The @capgo/home-indicator package allows you to hide and show the home button indicator in your Capacitor app.

Installation

To install the package, run the following command in your terminal:

npm install @capgo/home-indicator
npx cap sync

API

The package provides the following methods:

hide()

hide() => Promise

Hide the home indicator.

Since: 0.0.1

show()

show() => Promise

Show the home indicator.

Since: 0.0.1

isHidden()

isHidden() => Promise<{ hidden: boolean; }>

Get the home indicator status.

Returns: Promise<{ hidden: boolean; }>

Since: 0.0.1

CSS Variables

You can use --safe-area-inset-bottom to make sure your content is not hidden by the home indicator. This variable is injected by the plugin for Android. It's useful if you set real fullscreen mode on Android.

Example usage:

getWindow().setDecorFitsSystemWindows(false);

Credits

This plugin was created originally for Kick.com by Capgo

For more information and updates, check out Capgo.