Démarrage

Copier un prompt de configuration avec les étapes d'installation et la guide markdown complète 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 Aperçu

`hide`

Cacher l'indicateur d'accueil en bas de l'écran.

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

Disponible uniquement sur iOS. Aucun effet sur Android ou web.

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

await HomeIndicator.hide();

`show`

Montrer l'indicateur d'accueil en bas de l'écran.

Cela restaure la visibilité par défaut de l'indicateur d'accueil 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 d'accueil est actuellement caché.

Renvoie l'état de visibilité actuel de l'indicateur d'accueil 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-run la synchronisation lorsque les modifications publiques API se produisent en amont.