跳转至正文

指标 Capacitor 插件

隐藏或显示 iOS 主屏幕指示条,打造全屏沉浸式应用体验

安装

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

指南

如何在 Capacitor 中使用 Indicator

在设备上测试

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

Indicator 插件预览二维码 code

使用 @capgo/capacitor-home-indicator

Capacitor Home Indicator 插件,用于控制 iOS home indicator 的显示与隐藏。home indicator 是无实体 Home 键的 iOS 设备底部的水平条。

安装

bun add @capgo/capacitor-home-indicator
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { HomeIndicator } from '@capgo/capacitor-home-indicator';

API 概览

方法 描述
hide 隐藏屏幕底部的 Home Indicator。
show 显示屏幕底部的 Home Indicator。
isHidden 检查当前 Home Indicator 是否处于隐藏状态。

示例

hide()

隐藏屏幕底部的 Home Indicator。

import { HomeIndicator } from '@capgo/capacitor-home-indicator';

await HomeIndicator.hide();

show()

显示屏幕底部的 Home Indicator。

import { HomeIndicator } from '@capgo/capacitor-home-indicator';

await HomeIndicator.show();

isHidden()

检查当前 Home Indicator 是否处于隐藏状态。

import { HomeIndicator } from '@capgo/capacitor-home-indicator';

const { hidden } = await HomeIndicator.isHidden();
if (hidden) {
  console.log('Home indicator is hidden');
} else {
  console.log('Home indicator is visible');
}

完整参考文档

继续阅读 使用 @capgo/capacitor-home-indicator

如果你正在使用 使用 @capgo/capacitor-home-indicator 要规划原生插件工作,请将其与 @capgo/capacitor-home-indicator 了解 @capgo/capacitor-home-indicator 中的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Indicator 插件常见问题

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

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

@capgo/capacitor-home-indicator 是否支持 React、Vue 和 Angular?

支持。Indicator 是一个 Capacitor 包,因此它可以与任何在 Capacitor 中运行的 Web 框架配合使用,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

@capgo/capacitor-home-indicator 支持哪个 Capacitor 版本?

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

@capgo/capacitor-home-indicator 是免费开源的吗?

是的。code 源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-home-indicator/,并且你可以通过 npm 免费安装该包。欢迎提交 Bug 报告和 Pull Request。

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

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

无需等待应用审核,即可即时发布 Indicator 变更

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

开始使用 Capgo