Prise en main

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

Install

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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 en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API Présentation

`hide`

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

Cela masque 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 jusqu'à ce qu'ils 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, le rendant toujours visible pour l'utilisateur. C'est le comportement par défaut.

Disponible uniquement 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 la page d'accueil est actuellement caché.

Renvoie l'état actuel de la visibilité de l'indicateur de la page 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-faites la synchronisation lorsque les données publiques API changent en amont.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier l'interface de dashboard et les opérations API, connectez-le avec Utilisation de @capgo/capacitor-home-indicator pour la capacité native dans l'utilisation de @capgo/capacitor-home-indicator, Vue d'ensemble de API pour les détails d'implémentation dans la Vue d'ensemble de API, Introduction pour les détails d'implémentation dans l'Introduction, Clés de API pour les détails d'implémentation dans les Clés de API, et Appareils pour les détails d'implémentation dans les Appareils.