Getting Started

Install

bun add @capgo/capacitor-home-indicator
bunx cap sync

Import

import { HomeIndicator } from '@capgo/capacitor-home-indicator';

API Overview

hide

Hide the home indicator at the bottom of the screen.

This visually hides the iOS home indicator bar, providing a more immersive full-screen experience. Users can still swipe up to access home, but the indicator will not be visible until they start the gesture.

iOS only. Has no effect on Android or web.

import { HomeIndicator } from '@capgo/capacitor-home-indicator';

await HomeIndicator.hide();

show

Show the home indicator at the bottom of the screen.

This restores the default iOS home indicator visibility, making it always visible to the user. This is the default behavior.

iOS only. Has no effect on Android or web.

import { HomeIndicator } from '@capgo/capacitor-home-indicator';

await HomeIndicator.show();

isHidden

Check whether the home indicator is currently hidden.

Returns the current visibility state of the iOS home indicator.

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');
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.