はじめに

このプラグインのインストール手順とフルマークダウンガイドを含むセットアッププロンプトをコピーします。

        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のみ。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');
}

真実の源

このページはプラグインの src/definitions.tsパブリックAPIがアップストリームで変更されたときに再度Syncを実行してください。