# @capgo/capacitor-proximity 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-proximity/

版本：8\.1\.16
npm 元数据更新时间：2026-10-15T03:52:28.593Z
中文译文更新时间：2026-11-09T04:09:56.215Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-proximity
原文对照：https://npmcn.com/package/%40capgo/capacitor-proximity/?lang=original
项目主页：https://capgo.app/docs/plugins/proximity/
源码仓库：https://github.com/Cap-go/capacitor-proximity

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：44.1 kB，29 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-04-15T15:03:28.220Z
- 最新版本发布：2026-10-15T03:52:28.312Z
- 近 30 天下载量：39894（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

在移动应用程序中允许近距离监控的电容插件.

## 安装

```sh
npm install @capgo/capacitor-proximity
```

也可以使用：`pnpm add @capgo/capacitor-proximity`、`yarn add @capgo/capacitor-proximity`、`bun add @capgo/capacitor-proximity`

## README

# @ capgo/ 电容- 接近

手机被扣在耳朵上时,像本地手机应用一样,在您的Capacitor应用中为通话和语音信息提供空白或淡化屏幕.

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-proximity)](https://capgo.app/?ref=plugin_proximity)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_proximity)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_proximity) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-proximity` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _加入@capgo/capor-proximity到我的Capacitor应用上,并把它接上。"_ [代理设置指南](https://capgo.app/agents/?ref=plugin_proximity) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_proximity)

![@capgo/capacitor-proximity for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-proximity/main/assets/github-social-preview.png)

## 主要特点

-   **启用**数字 : `enable()` 开始近距离监控.
-   **禁用**数字 : `disable()` 别闹了.
-   **状态**数字 : `getStatus()` 返回传感器可用性和启用状态.
-   **原生传感器**数字 : `UIDevice` iOS的近距离监控. 在Android上,相近感应器将屏幕暗化到其最小的亮度,同时有东西接近.
-   **平台**: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 在网上不可用.

## 为什么这个插件

这个插件将iOS和Android使用的本地相近API包起来,因此Capacitor app可以:

-   当屏幕对用户的脸部或手部做出反应时,启用近距离监控.
-   当流动结束时, 清除它 .
-   检查当前设备是否支持传感器 .
-   从本地代码读取插件版本 .

在 iOS 上,插件直接转发到 `UIDevice.isProximityMonitoringEnabled`。 。 。 . 在Android上,它听取了设备相近感应器,并在感应器被覆盖时将活性应用窗口变暗.

## 平台支持

| 平台 | 支助 |
| --- | --- |
| iOS系统 | 使用本地近距离监测 |
| 机器人 | 用户 `Sensor.TYPE_PROXIMITY` 并淡化当前应用程序窗口 |
| 网页 | 不详 |

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| v八._。 。 。 ._ | v八._。 。 。 ._ | ✅ |
| v._。 。 。 ._ | v._。 。 。 ._ | 应要求 |
| v6 (英语)._。 。 。 ._ | v6 (英语)._。 。 。 ._ | ❌ |
| 页:1._。 。 。 ._ | 页:1._。 。 。 ._ | ❌ |

> 插件主版本遵循Capacitor主版本.

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

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

然后使用下列提示:

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

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
bun add @capgo/capacitor-proximity
bunx cap sync
```

## 使用量

```ts
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();
}
```

## 页:1

-   测试一个真正的设备。 模拟器和大多数桌面浏览器不会暴露出相近传感器.
-   在Android上,插件只会影响当前应用窗口. 它不能控制应用程序外的完整系统显示.
-   在iOS上,苹果公司一旦启用了近距离监控,就可以控制精确的屏蔽行为.

## 示例应用程序

这个 `example-app/` 文件夹包含一个小 Vite 演示,用于检查状态,启用插件,使其失效,并读取本地版本.

## API 密码

-   [`enable()`](https://npmcn.com/package/%40capgo/capacitor-proximity/#readme-enable)
-   [`disable()`](https://npmcn.com/package/%40capgo/capacitor-proximity/#readme-disable)
-   [`getStatus()`](https://npmcn.com/package/%40capgo/capacitor-proximity/#readme-getstatus)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-proximity/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-proximity/#readme-interfaces)

在移动应用程序中允许近距离监控的电容插件.

### 启用( )

```typescript
enable() => Promise<void>
```

启用近距离监控 .

IOS 启用 `UIDevice.isProximityMonitoringEnabled`。 。 。 . 在Android这个开始听 `TYPE_PROXIMITY` 淡化当前 传感器覆盖时的应用窗口 .

**自:** 0.0.1 资源

* * *

### 禁用( c)

```typescript
disable() => Promise<void>
```

禁用近距离监控.

这可以恢复默认的应用窗口行为并停止传感器监测.

**自:** 0.0.1 资源

* * *

### 获取状态( C)

```typescript
getStatus() => Promise<ProximityStatusResult>
```

获取当前传感器可用性和插件启用状态 .

**回返情况:** `Promise<[ProximityStatusResult](https://npmcn.com/package/%40capgo/capacitor-proximity/#readme-proximitystatusresult)>`

**自:** 0.0.1 资源

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<PluginVersionResult>
```

获取当前本地插件版本 .

**回返情况:** `Promise<[PluginVersionResult](https://npmcn.com/package/%40capgo/capacitor-proximity/#readme-pluginversionresult)>`

**自:** 0.0.1 资源

* * *

### 接口

#### 近似状态

返回结果 `getStatus()`。 。 。 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`available`** | `boolean` | 当前设备是否暴露出可用的相近传感器. | 0.0.1 资源 |
| **`enabled`** | `boolean` | 目前是否由插件启用近距离监视 . | 0.0.1 资源 |
| **`platform`** | `'ios' | 'android' | 'web'` | 由本地或网络执行返回的平台标签 . | 0.0.1 资源 |

#### 插件变压器

请求插件版本时返回结果 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`version`** | `string` | 本地插件版本字符串 . | 0.0.1 资源 |

## 常见问题

### @capgo/capacitor-proximity 是什么？

在移动应用程序中允许近距离监控的电容插件\.

### 如何安装 @capgo/capacitor-proximity？

在项目目录运行 npm install @capgo/capacitor-proximity，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-proximity 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-proximity 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-proximity 可以商用吗？

@capgo/capacitor-proximity 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-proximity 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-proximity 在 2026/10/09 – 2026/11/07 这 30 天内被下载 39,894 次，日均约 1,330 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-proximity 还在维护吗？

最新版本 8\.1\.16 发布于 2026/10/15（25 天前）；至今共发布 16 个版本，其中过去 12 个月发布了 16 个；首次发布于 2026/04/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。