Getting Started

Copia un prompt de configuración con los pasos de instalación y la guía de markdown completa para este 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.

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA con el siguiente comando:

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

Luego utilice el siguiente prompt:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siga las instrucciones específicas de la plataforma a continuación:

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

Importar

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

API Resumen

`hide`

Ocultar la indicadora de inicio en la parte inferior de la pantalla.

Esto oculta visualmente la barra de indicadora de inicio de iOS, proporcionando una experiencia de pantalla completa más inmersiva. Los usuarios aún pueden deslizar hacia arriba para acceder a la pantalla de inicio, pero la indicadora no estará visible hasta que comiencen el gesto.

Solo disponible en iOS. No tiene efecto en Android o web.

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

await HomeIndicator.hide();

`show`

Mostrar la indicadora de inicio en la parte inferior de la pantalla.

Restaura la visibilidad por defecto del indicador de inicio de iOS, haciéndolo visible siempre para el usuario. Este es el comportamiento por defecto.

Solo para iOS. No tiene efecto en Android o web.

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

await HomeIndicator.show();

`isHidden`

Verificar si el indicador de inicio está actualmente oculto.

Devuelve el estado actual de visibilidad del indicador de inicio de 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');
}

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.ts. Vuelva a sincronizar cuando los cambios públicos API cambien en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la pantalla de dashboard y las operaciones API, conecta con Usando @capgo/capacitor-home-indicator para la capacidad nativa en Usando @capgo/capacitor-home-indicator, API Overview para el detalle de implementación en API Overview, Introducción para el detalle de implementación en Introducción, API Keys para el detalle de implementación en API Keys, y Dispositivos para los detalles de implementación en dispositivos.