@capgo/capacitor-home-indicator

Overview

Hide or show iOS home indicator for fullscreen and immersive app experiences

Start with hide() and the other core methods listed below.

Platform support

Platform	Support	Notes
iOS	Yes	Native
Android	Yes	Native
Web	No	Guard with Capacitor.getPlatform()

Core Capabilities

• hide - Hide the home indicator at the bottom of the screen.
• show - Show the home indicator at the bottom of the screen.
• isHidden - Check whether the home indicator is currently hidden.

Public API

Method	Description
hide	Hide the home indicator at the bottom of the screen.
show	Show the home indicator at the bottom of the screen.
isHidden	Check whether the home indicator is currently hidden.
getPluginVersion	Get the native Capacitor plugin version.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-home-indicator.

Keep going from @capgo/capacitor-home-indicator

If you are using @capgo/capacitor-home-indicator to plan native plugin work, connect it with Using @capgo/capacitor-home-indicator for the native capability in Using @capgo/capacitor-home-indicator, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.