Getting Started

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

        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.

インストール

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-home-indicator` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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を実行してください。

続けて「Getting Started」から進みます

Capgoを使用している場合 Getting Started ダッシュボードとAPIの操作を計画するには、Capgoを Capgoの@capgo/capacitor-home-indicatorを使用 Capgoの@capgo/capacitor-home-indicatorのネイティブ機能のために API Overview for the implementation detail in API Overview, 導入導入の実装詳細のために API Keys for the implementation detail in API Keys, and デバイスデバイスの実装詳細について