Getting Started

Copier un prompt de configuration avec les étapes d'installation et le guide markdown complet pour ce 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`, `@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.

Installer

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

Importer

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

API Vue d'ensemble

`hide`

Masquer l'indicateur de domicile en bas de l'écran.

Cela masque visuellement la barre d'indicateur de domicile iOS, offrant une expérience d'écran plein écran plus immersive. Les utilisateurs peuvent toujours faire glisser vers le haut pour accéder à la maison, mais l'indicateur ne sera pas visible jusqu'à ce qu'ils commencent la gestuelle.

Seulement disponible sur iOS. Aucun effet sur Android ou web.

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

await HomeIndicator.hide();

`show`

Afficher l'indicateur de domicile en bas de l'écran.

Cela restaure la visibilité par défaut de l'indicateur de domicile iOS, la rendant toujours visible à l'utilisateur. C'est le comportement par défaut.

Seulement disponible sur iOS. Aucun effet sur Android ou web.

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

await HomeIndicator.show();

`isHidden`

Vérifiez si l'indicateur de domicile est actuellement masqué.

Renvoie l'état de visibilité actuel de l'indicateur de domicile iOS.

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 De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-faire la synchronisation lorsque les données publiques API changent en amont.

Continuer depuis Getting Started

Si vous utilisez Getting Started pour planifier les opérations de tableau de bord et API , connectez-le avec Utiliser @capgo/capacitor-home-indicator pour la capacité native dans Utiliser @capgo/capacitor-home-indicator, API Présentation pour les détails d'implémentation dans API Présentation, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.