跳转至正文

导航栏 Capacitor 插件

自定义 Android 导航栏颜色与可见性,打造沉浸式 UI 体验

安装

bun add @capgo/capacitor-navigation-bar bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-navigation-bar
  • pnpm add @capgo/capacitor-navigation-bar
  • yarn add @capgo/capacitor-navigation-bar

指南

如何在 Capacitor 中使用 Navigation Bar

在设备上测试

下载 Capgo App,然后扫描二维码 code。

Navigation Bar 插件预览二维码 code

使用 @capgo/capacitor-navigation-bar

Capacitor Navigation Bar 插件,用于自定义 Android 导航栏。

安装

bun add @capgo/capacitor-navigation-bar
bunx cap sync

插件暴露的内容

  • setNavigationBarColor - 设置导航栏颜色和按钮主题。
  • getNavigationBarColor - 获取当前的导航栏颜色和按钮主题。

用法示例

setNavigationBarColor

设置导航栏颜色和按钮主题。

import { NavigationBar, NavigationBarColor } from '@capgo/capacitor-navigation-bar';

// Set to white with dark buttons
await NavigationBar.setNavigationBarColor({
  color: NavigationBarColor.WHITE,
  darkButtons: true
});

// Set to custom color
await NavigationBar.setNavigationBarColor({
  color: '#FF5733',
  darkButtons: false
});

// Set a custom divider color on Android 9+
await NavigationBar.setNavigationBarColor({
  color: NavigationBarColor.WHITE,
  darkButtons: true,
  dividerColor: '#D9D9D9'
});

getNavigationBarColor

获取当前的导航栏颜色和按钮主题。

import { NavigationBar } from '@capgo/capacitor-navigation-bar';

const { color, darkButtons } = await NavigationBar.getNavigationBarColor();
console.log('Current color:', color);
console.log('Using dark buttons:', darkButtons);

完整参考

从“使用 @capgo/capacitor-navigation-bar”继续

如果你正在使用 使用 @capgo/capacitor-navigation-bar 来规划原生媒体和界面行为,并将其与 @capgo/capacitor-navigation-bar 有关 @capgo/capacitor-navigation-bar 的实现细节,请参阅: 快速入门 有关“入门指南”中的实现细节, 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力, @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 中的实现细节,以及 使用 @capgo/capacitor-video-player 有关“使用 @capgo/capacitor-video-player.”中的原生能力

常见问题

Navigation Bar 插件常见问题

如何在 Capacitor 应用中安装 Navigation Bar 插件?

运行 "bun add @capgo/capacitor-navigation-bar"(或 "npm install @capgo/capacitor-navigation-bar"),然后运行 "bunx cap sync",让 iOS 和 Android 项目引入原生 code。最后在你的应用 code 中从 "@capgo/capacitor-navigation-bar" 导入即可。

@capgo/capacitor-navigation-bar 是否支持 React、Vue 和 Angular?

支持。Navigation Bar 是一个 Capacitor 包,因此适用于任何在 Capacitor 中运行的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 以及纯 JavaScript。

@capgo/capacitor-navigation-bar 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-navigation-bar 是免费开源的吗?

是的。code 的源码已在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-navigation-bar/,也可以从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以在不经过 App Store 审核的情况下更新使用了 Navigation Bar 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App Store 审核,即可快速发布 Navigation Bar 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo