Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-proximity
Tutorial
by github.com/Cap-go

Proximity

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

Downloads/week

221

GitHub Stars

2

Guide

Tutorial on Proximity

Using @capgo/capacitor-proximity

Capacitor plugin for enabling proximity monitoring in mobile apps.

Install

bun add @capgo/capacitor-proximity
bunx cap sync

What This Plugin Exposes

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

Example Usage

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.