Einstieg

Einen Setup-Vorschlag mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-home-indicator`, `@capgo/home-indicator`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/home-indicator/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installieren

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

Importieren

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

API Übersicht

`hide`

Die Heimschaltfläche am unteren Bildschirmrand verbergen.

Dies versteckt die iOS-Heimschaltfläche visuell, bietet jedoch eine umfassendere vollbildschirmige Erfahrung. Benutzer können immer noch nach oben swipen, um zum Home zu gelangen, aber die Anzeige wird nicht sichtbar, bis sie den Gestus beginnen.

iOS nur. Hat keinen Einfluss auf Android oder Web.

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

await HomeIndicator.hide();

`show`

Die Heimschaltfläche am unteren Bildschirmrand anzeigen.

Dies setzt die Standard-Sichtbarkeit der iOS-Home-Indikator wieder her, sodass sie für den Benutzer immer sichtbar ist. Dies ist die Standardverhaltensweise.

iOS nur. Hat keinen Einfluss auf Android oder Web.

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

await HomeIndicator.show();

`isHidden`

Überprüfen Sie, ob der Home-Indikator derzeit verborgen ist.

Gibt die aktuelle Sichtbarkeitszustand des iOS-Home-Indikators zurück.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsWenn sich die öffentliche API upstream ändert, führen Sie die Synchronisation erneut durch.