Getting Started

Eine Einrichtungsvorschlagsanfrage mit den Installationsanweisungen und der vollständigen Markdown-Guideline 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 Heimansicht am unteren Bildschirmrand verstecken.

Dies versteckt die iOS-Heimansicht-Leiste visuell, was eine umfassendere vollbildschirmige Erfahrung bietet. Die Benutzer können immer noch nach oben fassen, um auf die Heimat 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 Heimansicht am unteren Bildschirmrand anzeigen.

Dies setzt die Standard- iOS-Heimansicht- Sichtbarkeit wieder her, was sie immer sichtbar für den Benutzer macht. Dies ist die Standardverhalten.

iOS nur. Hat keinen Einfluss auf Android oder Web.

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

await HomeIndicator.show();

`isHidden`

Überprüfen, ob die Heimansicht derzeit versteckt ist.

Gibt den aktuellen Sichtbarkeitszustand der iOS-Heimansicht 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.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weiter von Getting Started

Wenn Sie es verwenden Getting Started um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-home-indicator für die native Fähigkeit in Mit @capgo/capacitor-home-indicator, API Übersicht für die Implementierungsdetails in API Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.