スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いの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.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

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

インポート

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

クイックスタート

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

await HomeIndicator.hide();

例: 表示

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

await HomeIndicator.show();

例: isHidden

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

よくある落とし穴

• ネイティブ同期: 実行 npx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

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

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-home-indicator の使用方法 @capgo/capacitor-home-indicator を使用する際のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。