# @chefslist/capacitor-android-navigation-bar-info 中文文档

规范地址：https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/

版本：0\.0\.2
npm 元数据更新时间：2026-05-21T17:21:21.801Z
中文译文更新时间：2026-11-09T18:45:09.415Z
软件包许可：Apache License, Version 2\.0, January 2004

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

原始 npm 页面：https://www.npmjs.com/package/%40chefslist/capacitor-android-navigation-bar-info
原文对照：https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/?lang=original
项目主页：https://github.com/ChefsList/capacitor-android-navbar-info#readme
源码仓库：https://github.com/ChefsList/capacitor-android-navbar-info

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

- 包体积（解压后）：43.1 kB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=7\.0\.0
- 首次发布：2025-10-08T11:25:39.078Z
- 最新版本发布：2025-10-31T12:05:19.975Z
- 近 30 天下载量：1870（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

Android 获得导航条高、能见度和手势导航模式的电容插件

## 安装

```sh
npm install @chefslist/capacitor-android-navigation-bar-info
```

也可以使用：`pnpm add @chefslist/capacitor-android-navigation-bar-info`、`yarn add @chefslist/capacitor-android-navigation-bar-info`、`bun add @chefslist/capacitor-android-navigation-bar-info`

## README

# 电容器和机器人导航

Android 的 Capacittor 插件, 提供有关导航栏的信息, 如导航栏高度、 手势导航模式等

## 安装

```bash
npm install @chefslist/capacitor-android-navigation-bar-info
npx cap sync
```

## 使用量

### 获取导航栏信息

```typescript
import { NavigationBarInfo } from '@chefslist/capacitor-android-navigation-bar-info';

const info = await NavigationBarInfo.getNavigationBarInfo();
console.log('Navigation bar height:', info.heightInDp);
console.log('Device height:', info.deviceHeight);
console.log('Is visible:', info.isNavigationBarVisible);
console.log('Is gesture navigation:', info.isGestureNavigation);
```

### 听取导航栏更改

插件在导航栏信息变化时自动检测(例如,在Android 15+上的窗口模式和全屏模式之间切换时):

```typescript
import { NavigationBarInfo } from '@chefslist/capacitor-android-navigation-bar-info';

// Add listener for navigation bar changes
await NavigationBarInfo.addListener('navigationBarInfoChanged', (info) => {
  console.log('Navigation bar info changed:', info);
  // Update your UI based on new navigation bar dimensions
});

// Don't forget to remove listeners when component unmounts
await NavigationBarInfo.removeAllListeners();
```

## API 密码

-   [`getNavigationBarInfo()`](https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/#readme-getnavigationbarinfo)
-   [`addListener('navigationBarInfoChanged', ...)`](https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/#readme-addlistenernavigationbarinfochanged-)
-   [`removeAllListeners()`](https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/#readme-removealllisteners)
-   [接口](https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/#readme-interfaces)

### 获取Navigation BarInfo ()

```typescript
getNavigationBarInfo() => Promise<NavigationBarInfo>
```

**回返情况:** `Promise<[NavigationBarInfo](https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/#readme-navigationbarinfo)>`

* * *

### 添加聆听器( “ 导航BarInfoChanged ” ,...)

```typescript
addListener(eventName: 'navigationBarInfoChanged', listenerFunc: (info: NavigationBarInfo) => void) => Promise<PluginListenerHandle>
```

听取导航栏信息更改( 例如, 在窗口模式和全屏模式之间切换时)

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'navigationBarInfoChanged'` |
| **`listenerFunc`** | `(info: [NavigationBarInfo](https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/#readme-navigationbarinfo)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40chefslist/capacitor-android-navigation-bar-info/#readme-pluginlistenerhandle)>`

* * *

### 删除所有收听器( )

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

删除此插件的所有听众

* * *

### 接口

#### 导航列信息

| Prop | 类型 |
| --- | --- |
| **`heightInDp`** | `number` |
| **`deviceHeight`** | `number` |
| **`density`** | `number` |
| **`isNavigationBarVisible`** | `boolean` |
| **`isGestureNavigation`** | `boolean` |

#### 插件听筒

| Prop | 类型 |
| --- | --- |
| **`remove`** | `() => Promise<void>` |

## 常见问题

### @chefslist/capacitor-android-navigation-bar-info 是什么？

Android 获得导航条高、能见度和手势导航模式的电容插件

### 如何安装 @chefslist/capacitor-android-navigation-bar-info？

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

### @chefslist/capacitor-android-navigation-bar-info 支持 TypeScript 吗？

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

### @chefslist/capacitor-android-navigation-bar-info 支持 ESM 还是 CommonJS？

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

### @chefslist/capacitor-android-navigation-bar-info 可以商用吗？

@chefslist/capacitor-android-navigation-bar-info 使用 Apache License, Version 2\.0, January 2004 许可。声明的许可为 Apache License, Version 2\.0, January 2004，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @chefslist/capacitor-android-navigation-bar-info 的下载量有多少？

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

### @chefslist/capacitor-android-navigation-bar-info 还在维护吗？

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

