Simple Control
Turn proximity monitoring on when a flow starts and disable it cleanly when it ends.
@capgo/capacitor-proximity
Enable native proximity monitoring so your app can react when the device is held to the ear, covered by a hand, or placed face down.
Overview
Section titled “Overview”Capacitor plugin for enabling proximity monitoring in mobile apps.
Native iOS Behavior
Uses UIDevice.isProximityMonitoringEnabled so iOS handles the screen behavior natively.
Android Sensor Support
Listens to Sensor.TYPE_PROXIMITY and dims the current app window while the sensor is covered.
Availability Checks
Verify whether the current device exposes a usable proximity sensor before enabling the feature.
Version Reporting
Read the native plugin version at runtime for debugging, support, and diagnostics.
Comprehensive Documentation
Check the Getting Started guide to install and integrate the plugin quickly.
Core Capabilities
Section titled “Core Capabilities”enable- Enable proximity monitoring.disable- Disable proximity monitoring.getStatus- Get the current sensor availability and plugin enabled state.
Public API
Section titled “Public API”| Method | Description |
|---|---|
enable | Enable proximity monitoring. |
disable | Disable proximity monitoring. |
getStatus | Get the current sensor availability and plugin enabled state. |
getPluginVersion | Get the current native plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-proximity.
Keep going from @capgo/capacitor-proximity
Section titled “Keep going from @capgo/capacitor-proximity”If you are using @capgo/capacitor-proximity to plan native plugin work, connect it with Using @capgo/capacitor-proximity for the native capability in Using @capgo/capacitor-proximity, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.