Guide
How to use Indicator in Capacitor
Using @capgo/capacitor-home-indicator
Capacitor Home Indicator Plugin for controlling the iOS home indicator visibility. The home indicator is the horizontal bar at the bottom of iOS devices without a physical home button.
Install
bun add @capgo/capacitor-home-indicator
bunx cap sync
bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.
Import
import { HomeIndicator } from '@capgo/capacitor-home-indicator';
API at a glance
| 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. |
Examples
hide()
Hide the home indicator at the bottom of the screen.
import { HomeIndicator } from '@capgo/capacitor-home-indicator';
await HomeIndicator.hide();
show()
Show the home indicator at the bottom of the screen.
import { HomeIndicator } from '@capgo/capacitor-home-indicator';
await HomeIndicator.show();
isHidden()
Check whether the home indicator is currently hidden.
import { HomeIndicator } from '@capgo/capacitor-home-indicator';
const { hidden } = await HomeIndicator.isHidden();
if (hidden) {
console.log('Home indicator is hidden');
} else {
console.log('Home indicator is visible');
}
Full reference
Keep going from Using @capgo/capacitor-home-indicator
If you are using Using @capgo/capacitor-home-indicator to plan native plugin work, connect it with @capgo/capacitor-home-indicator for the implementation detail in @capgo/capacitor-home-indicator, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.