Skip to main content
@capgo/capacitor-proximity Device APIs Open source

Proximity Capacitor plugin

Enable native proximity monitoring so your app can react when the device is near a face, hand, or surface

Install

bun add @capgo/capacitor-proximity bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-proximity
  • pnpm add @capgo/capacitor-proximity
  • yarn add @capgo/capacitor-proximity

Guide

How to use Proximity in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

App Store Google Play
Proximity plugin preview QR code

Using @capgo/capacitor-proximity

Capacitor plugin for enabling proximity monitoring in mobile apps.

Install

bun add @capgo/capacitor-proximity
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

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

API at a glance

Method Description
enable Enable proximity monitoring.
disable Disable proximity monitoring.
getStatus Get the current sensor availability and plugin enabled state.

Examples

enable()

Enable proximity monitoring.

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

await CapacitorProximity.enable();

disable()

Disable proximity monitoring.

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

await CapacitorProximity.disable();

getStatus()

Get the current sensor availability and plugin enabled state.

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

const status = await CapacitorProximity.getStatus();

Full reference

Keep going from Using @capgo/capacitor-proximity

If you are using Using @capgo/capacitor-proximity to plan native plugin work, connect it with @capgo/capacitor-proximity for the implementation detail in @capgo/capacitor-proximity, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.

FAQ

Proximity plugin FAQ

How do I install the Proximity plugin in a Capacitor app?

Run "bun add @capgo/capacitor-proximity" (or "npm install @capgo/capacitor-proximity"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-proximity" in your app code.

Does @capgo/capacitor-proximity work with React, Vue and Angular?

Yes. Proximity is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-proximity support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-proximity free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-proximity/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Proximity without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Device APIs

Related plugins

Browse all plugins →

Ship Proximity changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo