Getting Started

GitHub

Eine Einrichtungsanleitung mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation 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

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Dann verwenden Sie die folgende Anfrage:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-home-indicator` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

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

Dies versteckt die iOS-Heimschaltflächenleiste visuell, um eine umfassendere vollbildschirm-Übertragung zu ermöglichen. Die Benutzer können den Heimbereich immer noch mit einem Wischen nach oben erreichen, aber die Indikatorleiste wird nicht sichtbar, bis sie den Gestenstart auslösen.

iOS nur. Hat keinen Effekt 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 des iOS-Home-Indikators wiederher, 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.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weitergehen von Getting Started

Wenn Sie "Getting Started" verwenden Um sich mit der Dashboard- und __CAPGO_KEEP_0__-Einstellung vertraut zu machen, verbinden Sie es mit Verwenden Sie @API/__CAPGO_KEEP_1__-home-indicator Verwenden Sie @capgo/capacitor-home-indicator für die native Fähigkeit in Verwenden Sie @capgo/capacitor-home-indicator for the native capability in Using @capgo/capacitor-home-indicator, API-Übersicht für die Implementierungsdetails in API-Übersicht for the implementation detail in API Overview, Einführung für die Implementierungsdetails in Einführung __CAPGO_KEEP_0__-Schlüssel API-Schlüssel für die Implementierungsdetails in API-Schlüssel API-Schlüssel für die Implementierungsdetails in API-Schlüssel Geräte für die Implementierungsdetails in Geräte.