Erste Schritte

Kopiere einen Setup-Prompt mit den Installationsschritten und dem vollständigen Markdown-Guide für dieses Plugin.

        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`
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

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

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

Importieren

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

Quickstart

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

await HomeIndicator.hide();

Beispiel: show

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

await HomeIndicator.show();

Beispiel: isHidden

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

Häufige Stolperfallen

Nativer Sync: ausführen npx cap sync nach Plugin-Upgrades.
Single Source of Truth: Vertrauen src/definitions.ts im GitHub Repo.

API Übersicht

`hide`

Home-Indikator am unteren Bildschirmrand ausblenden.

Dies blendet die iOS-Home-Indicator-Leiste visuell aus und sorgt so für ein immersiveres Vollbild-Erlebnis. Nutzer können weiterhin nach oben wischen, um zum Home-Bildschirm zu gelangen, der Indikator wird aber erst sichtbar, wenn sie die Geste starten.

Nur für iOS. Hat auf Android oder Web keine Auswirkung.

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

await HomeIndicator.hide();

`show`

Home-Indikator am unteren Bildschirmrand anzeigen.

Dies stellt die Standard-Sichtbarkeit des iOS-Home-Indikators wieder her, sodass er für den Nutzer immer sichtbar ist. Das ist das Standardverhalten.

Nur für iOS. Hat auf Android oder Web keine Auswirkung.

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

await HomeIndicator.show();

`isHidden`

Prüfen, ob der Home-Indikator aktuell ausgeblendet ist.

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

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit Verwendung von @capgo/capacitor-home-indicator für die native Funktion in Using @capgo/capacitor-home-indicator, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.