Primeros pasos

Instalación

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas para cada plataforma a continuación:

1. Instala el paquete

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

2. Muestra un loader 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 });

Inicio rápido

import { NativeLoader } from '@capgo/capacitor-native-loader';

await NativeLoader.configure({ defaults: {} });

Ejemplo: mostrar

import { NativeLoader } from '@capgo/capacitor-native-loader';

const result = await NativeLoader.show();
console.log(result);

Ejemplo: actualización

import { NativeLoader } from '@capgo/capacitor-native-loader';

await NativeLoader.update({ id: 'id-123' });

Errores comunes

• Inicializar una vez: run setup during app bootstrap.
• Sync nativo: ejecutar bunx cap sync tras actualizar los plugins.
• Fuente de verdad: confiar src/definitions.ts en el repo de GitHub.

Configurar valores por defecto

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

Top Loader estilo Chrome

Usa style: 'chrome' cuando quieras la clásica barra de progreso del navegador y que la WebView siga siendo usable debajo.

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

Usa style: 'siri-v2' cuando el estado de carga deba ser un movimiento de color nativo en los bordes de la app 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 el WebView

Usa setWebViewLayout cuando un native loader debe ocupar parte de la pantalla mientras el contenido web sigue visible y funcional.

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 el diseño original cuando la superficie nativa desaparece:

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

Loaders de Lottie e imágenes

Incluye archivos Lottie JSON o imágenes en el bundle de la app nativa y referéncialos 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

Se admiten assets remotos, pero los assets nativos integrados son mejores para los loaders de inicio, ya que están disponibles antes de que terminen la red y la inicialización de JavaScript.

Llamadas nativas en Swift

Otros plugins de iOS pueden llamar al loader compartido directamente.

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 en 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 del loader
placement	'center' | 'top' | 'bottom' | 'left' | 'right' | 'fullscreen' | 'around' | 'custom'	Posición en la superficie nativa
interactionMode	'passThrough' | 'block' | 'loaderOnly'	Gestión de toques
backgroundColor	string	Color del overlay (incluye alfa)
scrimColor	string	Color del scrim (pantalla completa o borde)
colors	string[]	Colores del gradiente del loader
progress	number	Origen del valor determinista 0 a 1
autoHide	number	Milisegundos antes de ocultarse automáticamente
asset	object	Fuente de imágenes o Lottie

Usa reducedMotion: 'system' para respetar la configuración de movimiento del usuario.