Skip to main content
Capgo logo
Back to plugins
@capgo/home-indicator
Tutorial
by github.com/Cap-go

Indicator

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

Downloads/week

20.1k

GitHub Stars

6

Guide

Tutorial on Indicator

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

What This Plugin Exposes

  • 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.

Example Usage

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