Premiers pas

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

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez la configuration manuelle, installez le plugin avec les commandes suivantes, puis suivez les instructions spécifiques à chaque plateforme ci-dessous :

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

Importer

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

Démarrage rapide

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

await HomeIndicator.hide();

Exemple : show

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

await HomeIndicator.show();

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

Erreurs courantes

Sync native : exécuter npx cap sync après une mise à jour du plugin.
Source de vérité: trust src/definitions.ts dans le repo GitHub.

Aperçu de API

`hide`

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

Cela masque visuellement la barre d'indicateur d'accueil iOS, offrant une expérience plein écran plus immersive. Les utilisateurs peuvent toujours balayer vers le haut pour revenir à l'accueil, mais l'indicateur ne sera visible qu'au début du geste.

iOS uniquement. Aucun effet sur Android ou le web.

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

await HomeIndicator.hide();

`show`

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

Cela rétablit la visibilité par défaut de l'indicateur d'accueil iOS, le rendant siempre visible pour l'utilisateur. C'est le comportement par défaut.

iOS uniquement. Aucun effet sur Android ou le web.

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

await HomeIndicator.show();

`isHidden`

Vérifier si l'indicateur d'accueil est actuellement masqué.

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 src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Premiers pas pour planifier les opérations du dashboard et de API, connectez-l’à Utilisation de @capgo/capacitor-home-indicator pour la capacité native dans l'utilisation de @capgo/capacitor-home-indicator, Aperçu de API pour les détails d'implémentation dans l'aperçu de API, Introduction pour les détails d'implémentation dans l'Introduction, Clés API pour les détails d'implémentation dans les clés API, et Appareils pour le détail d’implémentation dans Devices.