Getting Started

Instalación

Puedes utilizar nuestra configuración asistida por IA para instalar el plugin. Agrega las Capgo habilidades a tu herramienta de IA utilizando el siguiente comando:

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

Luego utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

1. Instalar el paquete

   bun add @capgo/capacitor-native-loader
   bunx cap sync

2. Mostrar un cargador nativo desde 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 });

Configurar valores por defecto

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

Cargador superior estilo Chrome

Usar style: 'chrome' cuando desees la barra de progreso de la pestaña del navegador y que la WebView permanezca usable debajo de ella.

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

Cargador de Aristas de Siri V2

Usar style: 'siri-v2' Cuando el estado de carga debe ser un movimiento de color completo en pantalla alrededor de la orilla de la aplicación en lugar de una tarjeta centrada.

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

Progreso de Actualización

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

Redimensionar La Vista Web

Usar setWebViewLayout cuando un cargador nativo debe poseer parte de la pantalla mientras el contenido web permanece visible y usable.

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

Restaurar la disposición original cuando la superficie nativa desaparezca:

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

Lottie Y Cargadores De Imágenes

Empaquetar JSON de Lottie o recursos de imagen en la aplicación nativa y referenciarlos desde 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',
  },
});

Nota

Recursos remotos están soportados, pero los activos nativos empaquetados son mejores para los cargadores de inicio porque están disponibles antes de que la inicialización de red y JavaScript termine.

Llamadas nativas Swift

Otros plugins de iOS pueden llamar directamente al cargador compartido.

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)

Llamadas nativas Kotlin

Otros plugins de Android pueden llamar al objeto público desde Kotlin o 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)

Opciones Comunes

Opción	Tipo	Descripción
style	'siri' | 'siri-v2' | 'chrome' | 'orbit' | 'ring' | 'pulse' | 'dots' | 'bars' | 'wave' | 'halo' | 'lottie' | 'image'	Renderizador de carga
placement	'center' | 'top' | 'bottom' | 'left' | 'right' | 'fullscreen' | 'around' | 'custom'	Posición de la superficie nativa
interactionMode	'passThrough' | 'block' | 'loaderOnly'	Gestión de toques
backgroundColor	string	Color del sobreimpuesto
scrimColor	string	Color del escenario de pantalla completa
colors	string[]	Colores del gradiente de carga
progress	number	Valor determinado desde 0 hasta 1
autoHide	number	Milisegundos antes de ocultarse automáticamente
asset	object	Fuente de Lottie o recurso de imagen

Usar reducedMotion: 'system' para respetar los ajustes de movimiento de plataforma del usuario.