--- description: Capacitor plugin to read the device's proximity sensor and detect nearby objects with real-time measurement updates. Supports Android and iOS. title: Capacitor Proximity Sensor Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/proximity-sensor.png --- [Skip to content ](#capacitor-proximity-sensor-plugin) [πŸ“² Introducing **Build Sharing** β€” get your builds onto testers' devices with a link & QR code. No account required. ](/blog/share-mobile-app-builds-with-testers/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Intercom ](/docs/sdks/capacitor/intercom/) * [ Intune ](/docs/sdks/capacitor/intune/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * Proximity Sensor [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Screen Dimming (iOS) ](#screen-dimming-ios) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Tauri ](/docs/sdks/capacitor/tauri/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ YouTube Player ](/docs/sdks/capacitor/youtube-player/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Notifications * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Screen Dimming (iOS) ](#screen-dimming-ios) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Proximity Sensor Plugin[ΒΆ](#capacitor-proximity-sensor-plugin "Permanent link") Capacitor plugin to read the device's proximity sensor. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") The Capacitor Proximity Sensor plugin is one of the most complete proximity sensing solutions for Capacitor apps. Here are some of the key features: * πŸ–₯️ **Cross-platform**: Supports Android and iOS. * πŸ“ **Proximity detection**: Detect whether an object is close to the screen. * ⚑ **Real-time updates**: Continuous proximity data with event listeners. * 🀝 **Compatibility**: Works alongside the [Accelerometer](https://capawesome.io/docs/sdks/capacitor/accelerometer/), [Barometer](https://capawesome.io/docs/sdks/capacitor/barometer/) and [Gyroscope](https://capawesome.io/docs/sdks/capacitor/gyroscope/) plugins. * πŸ“¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Use Cases[ΒΆ](#use-cases "Permanent link") The Proximity Sensor plugin is typically used to react when an object is close to the device's screen, for example: * **Calling and VoIP apps**: Detect when the user holds the device to their ear during a call. * **Pocket detection**: Detect when the device is in a pocket or bag to ignore accidental input. * **Proximity-triggered actions**: Start or stop app behavior based on real-time `measurement` events. ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Guides[ΒΆ](#guides "Permanent link") * [The Complete Guide to Capacitor Device Sensors](https://capawesome.io/blog/capacitor-device-sensors-guide/): How proximity events pair with the Light Sensor in call and media apps that adapt to the environment. ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-proximity-sensor` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-proximity-sensor [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[ΒΆ](#android "Permanent link") #### Proguard[ΒΆ](#proguard "Permanent link") If you are using Proguard, you need to add the following rules to your `proguard-rules.pro` file: `[](#%5F%5Fcodelineno-3-1)-keep class io.capawesome.capacitorjs.plugins.** { *; } ` ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") The following examples show how to check whether the proximity sensor is available, get a single measurement, and start and stop continuous measurement updates. ### Check whether the sensor is available[ΒΆ](#check-whether-the-sensor-is-available "Permanent link") Not every device has a proximity sensor, so check its availability first. Only available on Android and iOS: `[](#%5F%5Fcodelineno-4-1)import { ProximitySensor } from '@capawesome/capacitor-proximity-sensor'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const isAvailable = async () => { [](#%5F%5Fcodelineno-4-4) const result = await ProximitySensor.isAvailable(); [](#%5F%5Fcodelineno-4-5) return result.available; [](#%5F%5Fcodelineno-4-6)}; ` ### Get a single measurement[ΒΆ](#get-a-single-measurement "Permanent link") Read the most recent measurement from the proximity sensor. Note that on iOS, reading the measurement enables proximity monitoring, which turns off the screen while an object is close to the sensor (see [Screen Dimming (iOS)](#screen-dimming-ios)): `[](#%5F%5Fcodelineno-5-1)import { ProximitySensor } from '@capawesome/capacitor-proximity-sensor'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const getMeasurement = async () => { [](#%5F%5Fcodelineno-5-4) const measurement = await ProximitySensor.getMeasurement(); [](#%5F%5Fcodelineno-5-5) console.log('Near: ', measurement.near); [](#%5F%5Fcodelineno-5-6) console.log('Distance: ', measurement.distance); [](#%5F%5Fcodelineno-5-7)}; ` ### Start and stop measurement updates[ΒΆ](#start-and-stop-measurement-updates "Permanent link") Listen for continuous `measurement` events. On iOS, proximity monitoring stays enabled until `stopMeasurementUpdates()` (or `removeAllListeners()`) is called: `[](#%5F%5Fcodelineno-6-1)import { ProximitySensor } from '@capawesome/capacitor-proximity-sensor'; [](#%5F%5Fcodelineno-6-2) [](#%5F%5Fcodelineno-6-3)const startMeasurementUpdates = async () => { [](#%5F%5Fcodelineno-6-4) await ProximitySensor.addListener('measurement', measurement => { [](#%5F%5Fcodelineno-6-5) console.log('Near: ', measurement.near); [](#%5F%5Fcodelineno-6-6) console.log('Distance: ', measurement.distance); [](#%5F%5Fcodelineno-6-7) }); [](#%5F%5Fcodelineno-6-8) await ProximitySensor.startMeasurementUpdates(); [](#%5F%5Fcodelineno-6-9)}; [](#%5F%5Fcodelineno-6-10) [](#%5F%5Fcodelineno-6-11)const stopMeasurementUpdates = async () => { [](#%5F%5Fcodelineno-6-12) await ProximitySensor.stopMeasurementUpdates(); [](#%5F%5Fcodelineno-6-13)}; [](#%5F%5Fcodelineno-6-14) [](#%5F%5Fcodelineno-6-15)const removeAllListeners = async () => { [](#%5F%5Fcodelineno-6-16) await ProximitySensor.removeAllListeners(); [](#%5F%5Fcodelineno-6-17)}; ` ## API[ΒΆ](#api "Permanent link") * [getMeasurement()](#getmeasurement) * [isAvailable()](#isavailable) * [startMeasurementUpdates()](#startmeasurementupdates) * [stopMeasurementUpdates()](#stopmeasurementupdates) * [addListener('measurement', ...)](#addlistenermeasurement-) * [removeAllListeners()](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### getMeasurement()[ΒΆ](#getmeasurement "Permanent link") `[](#%5F%5Fcodelineno-7-1)getMeasurement() => Promise ` Get the latest measurement. This method returns the most recent measurement from the proximity sensor. On iOS, reading the measurement enables proximity monitoring, which turns off the screen while an object is close to the sensor. Only available on Android and iOS. **Returns:** `Promise<[Measurement](#measurement)>` **Since:** 0.1.0 --- ### isAvailable()[ΒΆ](#isavailable "Permanent link") `[](#%5F%5Fcodelineno-8-1)isAvailable() => Promise ` Check if the proximity sensor is available on the device. Only available on Android and iOS. **Returns:** `Promise<[IsAvailableResult](#isavailableresult)>` **Since:** 0.1.0 --- ### startMeasurementUpdates()[ΒΆ](#startmeasurementupdates "Permanent link") `[](#%5F%5Fcodelineno-9-1)startMeasurementUpdates() => Promise ` Start emitting `measurement` events. On iOS, this enables proximity monitoring, which turns off the screen while an object is close to the sensor. Only available on Android and iOS. **Since:** 0.1.0 --- ### stopMeasurementUpdates()[ΒΆ](#stopmeasurementupdates "Permanent link") `[](#%5F%5Fcodelineno-10-1)stopMeasurementUpdates() => Promise ` Stop emitting `measurement` events. On iOS, this disables proximity monitoring. Only available on Android and iOS. **Since:** 0.1.0 --- ### addListener('measurement', ...)[ΒΆ](#addlistenermeasurement "Permanent link") `[](#%5F%5Fcodelineno-11-1)addListener(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) => void) => Promise ` Called when a new measurement is available. Only available on Android and iOS. | Param | Type | | ---------------- | -------------------------------------------- | | **eventName** | 'measurement' | | **listenerFunc** | (event: [Measurement](#measurement)) => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 0.1.0 --- ### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link") `[](#%5F%5Fcodelineno-12-1)removeAllListeners() => Promise ` Remove all listeners for this plugin. **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### Measurement[ΒΆ](#measurement "Permanent link") | Prop | Type | Description | Since | | ------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **distance** | number \| null | The distance between the sensor and the nearby object in centimeters (cm). Most devices only report whether an object is near or far, so this value is typically either 0 (near) or the sensor's maximum range (far). Only available on Android. Always null on iOS. | 0.1.0 | | **near** | boolean | Whether an object is close to the sensor. | 0.1.0 | #### IsAvailableResult[ΒΆ](#isavailableresult "Permanent link") | Prop | Type | Description | Since | | ------------- | ------- | -------------------------------------------------------- | ----- | | **available** | boolean | Whether the proximity sensor is available on the device. | 0.1.0 | #### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link") | Prop | Type | | ---------- | ------------------- | | **remove** | () => Promise | ### Type Aliases[ΒΆ](#type-aliases "Permanent link") #### GetMeasurementResult[ΒΆ](#getmeasurementresult "Permanent link") `[Measurement](#measurement)` #### MeasurementEvent[ΒΆ](#measurementevent "Permanent link") `[Measurement](#measurement)` ## Screen Dimming (iOS)[ΒΆ](#screen-dimming-ios "Permanent link") On iOS, reading the proximity sensor requires enabling proximity monitoring via `UIDevice`. While monitoring is enabled, iOS automatically turns off the screen whenever an object (such as the user's ear or a hand) is close to the sensor, exactly like during a phone call. This is a system-level behavior that cannot be disabled. For this reason, monitoring is only enabled while it is needed: * `getMeasurement()` enables monitoring, reads the current state and disables it again. * `startMeasurementUpdates()` keeps monitoring enabled until `stopMeasurementUpdates()` (or `removeAllListeners()`) is called. Only call `startMeasurementUpdates()` when you actually want this behavior. On Android, reading the proximity sensor has no effect on the screen. ## FAQ[ΒΆ](#faq "Permanent link") ### How is this plugin different from other similar plugins?[ΒΆ](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link") It covers the whole proximity story through one fully typed API: a one-time reading, continuous real-time `measurement` events, and an availability check, working consistently across Android and iOS. It surfaces platform specifics honestly β€” a distance in centimeters on Android and the near/far state on iOS β€” and documents the iOS screen-dimming behavior so there are no surprises. The package is kept current with the latest Capacitor version and ships for both CocoaPods and Swift Package Manager. ### Why does the screen turn off on iOS when reading the sensor?[ΒΆ](#why-does-the-screen-turn-off-on-ios-when-reading-the-sensor "Permanent link") On iOS, reading the proximity sensor requires enabling proximity monitoring via `UIDevice`. While monitoring is enabled, iOS automatically turns off the screen whenever an object is close to the sensor, exactly like during a phone call. This is a system-level behavior that cannot be disabled. See the [Screen Dimming (iOS)](#screen-dimming-ios) section for details. ### Why is the `distance` value always `null` on iOS?[ΒΆ](#why-is-the-distance-value-always-null-on-ios "Permanent link") iOS only reports whether an object is near the sensor via the `near` property. The `distance` value in centimeters is only available on Android and is always `null` on iOS. ### Why is the `distance` value always either `0` or the maximum range on Android?[ΒΆ](#why-is-the-distance-value-always-either-0-or-the-maximum-range-on-android "Permanent link") Most devices only report whether an object is near or far instead of an exact distance. The `distance` value is therefore typically either `0` (near) or the sensor's maximum range (far). ### How can I check whether a device has a proximity sensor?[ΒΆ](#how-can-i-check-whether-a-device-has-a-proximity-sensor "Permanent link") Call the `isAvailable()` method before using the sensor. It returns whether the proximity sensor is available on the device. ### Does this plugin work on the Web?[ΒΆ](#does-this-plugin-work-on-the-web "Permanent link") No, this plugin is only available on Android and iOS, since browsers do not expose the device's proximity sensor. ### Can I use this plugin with Ionic, React, Vue or Angular?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link") Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects. ## Related Plugins[ΒΆ](#related-plugins "Permanent link") * [Accelerometer](https://capawesome.io/docs/sdks/capacitor/accelerometer/): Capture the acceleration force along the x, y, and z axes. * [Barometer](https://capawesome.io/docs/sdks/capacitor/barometer/): Obtain the static air pressure in hectopascals (hPa). * [Gyroscope](https://capawesome.io/docs/sdks/capacitor/gyroscope/): Read the device's gyroscope sensor. * [Light Sensor](https://capawesome.io/docs/sdks/capacitor/light-sensor/): Read the device's ambient light sensor. ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/proximity-sensor/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/proximity-sensor/LICENSE). July 8, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/proximity-sensor/#article", "headline": "Capacitor Proximity Sensor Plugin", "name": "Capacitor Proximity Sensor Plugin", "description": "Capacitor plugin to read the device's proximity sensor and detect nearby objects with real-time measurement updates. Supports Android and iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/proximity-sensor/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/proximity-sensor/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/proximity-sensor/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/proximity-sensor/#software", "name": "Capacitor Proximity Sensor Plugin", "description": "Capacitor plugin to read the device's proximity sensor and detect nearby objects with real-time measurement updates. Supports Android and iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/proximity-sensor/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "It covers the whole proximity story through one fully typed API: a one-time reading, continuous real-time measurement events, and an availability check, working consistently across Android and iOS. It surfaces platform specifics honestly β€” a distance in centimeters on Android and the near/far state on iOS β€” and documents the iOS screen-dimming behavior so there are no surprises. The package is kept current with the latest Capacitor version and ships for both CocoaPods and Swift Package Manager."}}, {"@type": "Question", "name": "Why does the screen turn off on iOS when reading the sensor?", "acceptedAnswer": {"@type": "Answer", "text": "On iOS, reading the proximity sensor requires enabling proximity monitoring via UIDevice. While monitoring is enabled, iOS automatically turns off the screen whenever an object is close to the sensor, exactly like during a phone call. This is a system-level behavior that cannot be disabled. See the Screen Dimming (iOS) section for details."}}, {"@type": "Question", "name": "Why is the distance value always null on iOS?", "acceptedAnswer": {"@type": "Answer", "text": "iOS only reports whether an object is near the sensor via the near property. The distance value in centimeters is only available on Android and is always null on iOS."}}, {"@type": "Question", "name": "Why is the distance value always either 0 or the maximum range on Android?", "acceptedAnswer": {"@type": "Answer", "text": "Most devices only report whether an object is near or far instead of an exact distance. The distance value is therefore typically either 0 (near) or the sensor's maximum range (far)."}}, {"@type": "Question", "name": "How can I check whether a device has a proximity sensor?", "acceptedAnswer": {"@type": "Answer", "text": "Call the isAvailable() method before using the sensor. It returns whether the proximity sensor is available on the device."}}, {"@type": "Question", "name": "Does this plugin work on the Web?", "acceptedAnswer": {"@type": "Answer", "text": "No, this plugin is only available on Android and iOS, since browsers do not expose the device's proximity sensor."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/proximity-sensor/"} ```