开始使用

复制一个包含安装步骤和本插件的完整Markdown指南的设置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-home-indicator`, `@capgo/home-indicator`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/home-indicator/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

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

导入

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

API概述

`hide`

隐藏 iOS 屏幕底部的指示器。

这会使 iOS 屏幕的视觉效果更为沉浸式，提供全屏体验。用户仍然可以通过滑动来访问主屏幕，但直到他们开始滑动动作，指示器不会可见。

仅适用于 iOS。对 Android 或 web 无效。

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

await HomeIndicator.hide();

`show`

在屏幕底部显示导航指示器。

恢复 iOS 的默认导航指示器可见性，使其始终对用户可见。这是默认行为。

仅限 iOS。对 Android 或 web 无效。

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

await HomeIndicator.show();

`isHidden`

检查导航指示器当前是否隐藏。

返回 iOS 导航指示器当前可见状态。

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_KEEP_0__ 时重新运行。 src/definitions.ts重新同步公共 API 时重新运行。