はじめに

インストール

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-native-loader` plugin in my project.

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

1. Install the package

   npm install @capgo/capacitor-native-loader
   npx cap sync

2. Show a native loader from JavaScript

   import { NativeLoader } from '@capgo/capacitor-native-loader';
   
   const { id } = await NativeLoader.show({
     style: 'siri',
     placement: 'fullscreen',
     message: 'Preparing workspace',
     colors: ['#71f6ff', '#8b5cf6', '#ff4ecd', '#fff7ad'],
     scrimColor: 'rgba(3, 7, 18, 0.42)',
     interactionMode: 'block',
   });
   
   await doExpensiveWork();
   
   await NativeLoader.hide({ id });

Configure Defaults

await NativeLoader.configure({
  defaults: {
    style: 'orbit',
    placement: 'center',
    size: 96,
    colors: ['#38bdf8', '#a78bfa'],
    reducedMotion: 'system',
    interactionMode: 'passThrough',
  },
});

Chrome-Style Top Loader

Use style: 'chrome' when you want the familiar browser top progress bar and the WebView should stay usable below it.

const { id } = await NativeLoader.show({
  style: 'chrome',
  placement: 'top',
  colors: ['#4285f4', '#34a853', '#fbbc05', '#ea4335'],
  thickness: 4,
  interactionMode: 'passThrough',
  webView: {
    mode: 'resize',
    insets: { top: 12 },
    restoreOnHide: true,
  },
});

await NativeLoader.hide({ id, restoreWebView: true });

Siri V2 エッジ ローダー

使用 style: 'siri-v2' ロード中の状態がアプリのエッジ周りに動き回る、全画面のカラーのネイティブのモーションになるようにする場合に使用します。

const { id } = await NativeLoader.show({
  style: 'siri-v2',
  placement: 'fullscreen',
  colors: ['#71f6ff', '#8b5cf6', '#ff4ecd', '#fff7ad'],
  thickness: 10,
  scrimColor: 'rgba(3, 7, 18, 0.10)',
  interactionMode: 'passThrough',
});

await NativeLoader.hide({ id });

アップデートの進行状況

const { id } = await NativeLoader.show({
  style: 'ring',
  message: 'Uploading',
  progress: 0,
});

for await (const progress of uploadFile(file)) {
  await NativeLoader.setProgress({ id, progress });
}

await NativeLoader.hide({ id });

ウェブビューのサイズを変更

使用 setWebViewLayout 画面の一部をネイティブのローダーが占有しながら、ウェブコンテンツは表示され、使用可能なままになる場合。

await NativeLoader.setWebViewLayout({
  mode: 'inset',
  insets: { top: 96, bottom: 24 },
  animated: true,
});

await NativeLoader.show({
  style: 'wave',
  placement: 'top',
  size: 72,
  message: 'Syncing',
  interactionMode: 'passThrough',
});

ネイティブのサーフェイスが消えたときに元のレイアウトを復元する:

await NativeLoader.hideAll({ restoreWebView: true });

Lottie とイメージローダー

ネイティブアプリ内で Lottie JSON またはイメージアセットをバンドルし、JavaScript から参照する。

await NativeLoader.show({
  style: 'lottie',
  placement: 'center',
  asset: {
    type: 'lottie',
    source: 'rocket-loader.json',
    loop: true,
  },
});

await NativeLoader.show({
  style: 'image',
  placement: 'bottom',
  asset: {
    type: 'image',
    source: 'loader-frame',
  },
});

注意

リモートアセットはサポートされているが、起動ローダー用にバンドルされたネイティブアセットは、ネットワーキングとJavaScriptの初期化が完了する前に利用できるため、起動ローダーではそれがより適している。

Native Swift Calls

他のiOSプラグインは、共有ローダーを直接呼び出すことができます。

import CapgoCapacitorNativeLoader

let id = NativeLoader.shared.show(options: [
  "style": "siri",
  "placement": "fullscreen",
  "message": "Opening secure session",
  "interactionMode": "block"
])

NativeLoader.shared.setProgress(id: id, progress: 0.6)
NativeLoader.shared.hide(id: id)

Native Kotlin Calls

他のAndroidプラグインは、KotlinまたはJavaからパブリックオブジェクトを呼び出すことができます。

import app.capgo.nativeloader.NativeLoader

val id = NativeLoader.show(
  activity = activity,
  options = mapOf(
    "style" to "orbit",
    "placement" to "fullscreen",
    "message" to "Loading profile",
    "interactionMode" to "block",
  ),
  webView = bridge.webView,
)

NativeLoader.setProgress(id, 0.6)
NativeLoader.hide(id)

Common Options

オプション	タイプ	説明
style	'siri' | 'siri-v2' | 'chrome' | 'orbit' | 'ring' | 'pulse' | 'dots' | 'bars' | 'wave' | 'halo' | 'lottie' | 'image'	ローダー レンダラー
placement	'center' | 'top' | 'bottom' | 'left' | 'right' | 'fullscreen' | 'around' | 'custom'	ネイティブ サーフェイスの位置
interactionMode	'passThrough' | 'block' | 'loaderOnly'	タッチ ハンドリング
backgroundColor	string	オーバーレイの色、アルファ含む
scrimColor	string	フルスクリーンまたは周囲スクリーン スクリムの色
colors	string[]	ローダーのグラデーション色
progress	number	__CAPGO_KEEP_0__から__CAPGO_KEEP_1__までの値 0 __CAPGO_KEEP_0__から__CAPGO_KEEP_1__まで 1
autoHide	number	__CAPGO_KEEP_0__ミリ秒後自動的に非表示
asset	object	Lottieまたは画像アセットのソース

使用 reducedMotion: 'system' __CAPGO_KEEP_0__を使用するユーザーのプラットフォームモーション設定を尊重する.