@capgo/capacitor-proximity

Capacitor plugin for enabling proximity monitoring in mobile apps.

Why this plugin

This plugin wraps the native proximity APIs used by iOS and Android so a Capacitor app can:

• Enable proximity monitoring when a screen should react to the user's face or hand.
• Disable it cleanly when the flow ends.
• Check whether the current device supports the sensor.
• Read the plugin version from native code.

On iOS, the plugin forwards directly to UIDevice.isProximityMonitoringEnabled. On Android, it listens to the device proximity sensor and dims the active app window while the sensor is covered.

Platform support

Compatibility

The plugin major version follows the Capacitor major version.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

bun add @capgo/capacitor-proximity
bunx cap sync

Usage

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

const status = await CapacitorProximity.getStatus();

if (status.available) {
  await CapacitorProximity.enable();

  // ...run your near-ear or face-down flow...

  await CapacitorProximity.disable();
}

Notes

• Test on a real device. Simulators and most desktop browsers do not expose a proximity sensor.
• On Android, the plugin only affects the current app window. It does not control the full system display outside your app.
• On iOS, Apple controls the exact screen-off behavior once proximity monitoring is enabled.

Example app

The example-app/ folder contains a small Vite demo for checking status, enabling the plugin, disabling it, and reading the native version.

API

enable() => Promise<void>

disable() => Promise<void>

getStatus() => Promise<ProximityStatusResult>

getPluginVersion() => Promise<PluginVersionResult>