Empezar

Copie una solicitud de configuración con los pasos de instalación y la guía de markdown completa para este complemento.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-proximity`
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/proximity/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

bun add @capgo/capacitor-proximity
bunx cap sync

Importar

import { CapacitorProximity } from '@capgo/capacitor-proximity';

API Resumen

`enable`

En iOS, esto habilita

el seguimiento de proximidad UIDevice.isProximityMonitoringEnabledOn Android esto comienza a escuchar a TYPE_PROXIMITY y desvanece la ventana de la aplicación actual mientras el sensor está cubierto.

import { CapacitorProximity } from '@capgo/capacitor-proximity';

await CapacitorProximity.enable();

`disable`

Desactivar el seguimiento de proximidad.

Esto restaura el comportamiento de ventana de aplicación por defecto y detiene el seguimiento del sensor.

import { CapacitorProximity } from '@capgo/capacitor-proximity';

await CapacitorProximity.disable();

`getStatus`

Obtener el estado actual de disponibilidad del sensor y el plugin habilitado.

import { CapacitorProximity } from '@capgo/capacitor-proximity';

const status = await CapacitorProximity.getStatus();

Referencia de tipos

`ProximityStatusResult`

Resultado devuelto por getStatus().

export interface ProximityStatusResult {
  /**
   * Whether the current device exposes a usable proximity sensor.
   *
   * @since 0.0.1
   */
  available: boolean;

  /**
   * Whether proximity monitoring is currently enabled by the plugin.
   *
   * @since 0.0.1
   */
  enabled: boolean;

  /**
   * Platform label returned by the native or web implementation.
   *
   * @since 0.0.1
   */
  platform: 'ios' | 'android' | 'web';
}

`PluginVersionResult`

Resultado devuelto cuando se solicita la versión del plugin.

export interface PluginVersionResult {
  /**
   * Native plugin version string.
   *
   * @since 0.0.1
   */
  version: string;
}

Fuente de Verdad

Esta página se genera a partir de la configuración del plugin. src/definitions.tsRe-rerun la sincronización cuando los cambios públicos API cambien en la fuente.