Einstieg

Installation

Sie können unser AI-gestütztes Setup verwenden, um den Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Installation bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

1. Install die Paket

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

2. Ein nativem Loader aus JavaScript anzeigen

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

Standardeinstellungen konfigurieren

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

Chrome-Style Top Loader

Verwenden Sie style: 'chrome' wenn Sie das vertraute Browser-Top-Progress-Balken und die WebView unten darunter verwenden möchten.

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 Edge Loader

Verwenden style: 'siri-v2' Wenn der Ladezustand ein natürlicher, vollbildschirmiger Farb- und Bewegungseffekt um die App-Kante sein soll, anstatt ein zentriertes Karten-Element.

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

Aktualisierungsfortschritt

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

Die WebView skalieren

Verwenden setWebViewLayout Wenn ein nativer Loader einen Teil der Bildschirmfläche besitzen soll, während die Webinhalte sichtbar und nutzbar bleiben.

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

Die ursprüngliche Anordnung wiederherstellen, wenn die native Oberfläche verschwunden ist:

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

Lottie- und Bildlader

Lottie-JSON- oder Bildassets in der native App verpacken und von JavaScript aus referenzieren.

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

Hinweis

Fernassets werden unterstützt, aber verpackte native Assets sind für Startlader besser, da sie vor dem Netzwerk- und JavaScript-Initialisierung abrufbar sind.

Native Swift Aufrufe

Andere iOS-Plugins können den gemeinsamen Loader direkt aufrufen.

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 Aufrufe

Andere Android-Plugins können die öffentliche Klasse von Kotlin oder Java aufrufen.

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)

Gemeinsame Optionen

Option	Typ	Beschreibung
style	'siri' | 'siri-v2' | 'chrome' | 'orbit' | 'ring' | 'pulse' | 'dots' | 'bars' | 'wave' | 'halo' | 'lottie' | 'image'	Laderrenderer
placement	'center' | 'top' | 'bottom' | 'left' | 'right' | 'fullscreen' | 'around' | 'custom'	Position des nativen Oberflächenbereichs
interactionMode	'passThrough' | 'block' | 'loaderOnly'	Berührungshandling
backgroundColor	string	Überlagerungsfarbe, einschließlich Alpha
scrimColor	string	Vollbildschirm- oder umschließende-Schattenfarbe
colors	string[]	Farben des Ladergradienten
progress	number	Bestimmte Werte von 0 bis 1
autoHide	number	Millisekunden vor automatischer Versteckung
asset	object	Quelle des Lottie- oder Bildassets

Verwenden reducedMotion: 'system' um die Plattform-Bewegungseinstellungen des Benutzers zu respektieren.