@capgo/capacitor-widget-kit

Resumen

@capgo/capacitor-widget-kit proporciona a una aplicación Capacitor dos formas de impulsar widgets y Actividades en vivo:

• Actividades de plantilla SVG: define superficies de WidgetKit como SVG, cambia marcos nombrados desde toques, ejecuta temporizadores de pausa/reproducción, muta el estado JSON y recopila eventos de acción en la aplicación.
• Sesiones de widget nativo completo: mantiene la interfaz de usuario del widget completamente en Swift/Kotlin/Java mientras Capacitor administra el estado JSON compartido y mensajes de la aplicación a la widget o de la widget a la aplicación.

Utilice plantillas SVG cuando su widget pueda ser renderizado a partir de cadenas de SVG resueltas. Utilice sesiones de widget nativo completo cuando el widget necesite una interfaz de usuario nativa personalizada pero aún tenga que iniciar, detener, sincronizar el estado o pedir a la aplicación que complete el trabajo asíncrono.

Demostración

Flujo de plantilla del widget

Elegir un modo

Modo	Lo mejor para	API principales
Actividad de plantilla SVG	Actividades en vivo o superficies de widget que se renderizan desde la salida SVG	startTemplateActivity, performTemplateAction, listTemplateEvents
Sesión de widget nativo completa	Widgets renderizados nativamente que necesitan estado compartido y tareas asíncronas	startWidgetSession, updateWidgetSession, sendWidgetMessage

En ambos modos pueden coexistir en la misma aplicación. Por ejemplo, una aplicación de entrenamiento puede utilizar una Actividad de SVG en vivo para controles de marco/tiempo rápidos y una sesión de widget nativo completo para un widget de pantalla de inicio con un diseño de layout nativo más rico.

Capacidades de plantillas de SVG

Las plantillas de SVG incluyen las piezas necesarias para superficies de widget interactivas:

• frames variantes de SVG nombrados como summary, timer, o details.
• frameMutations pulsar, cambiar, o avanzar por marcos después de una acción de hotspot.
• timerMutations iniciar, pausar, reanudar, activar/desactivar, resetear, detener, o cambiar la duración del temporizador.
• patches actualizar el estado JSON utilizando valores literales, plantillas, timestamps, incrementos, activadores/desactivadores, o operaciones de deshacer.
• hotspots asignar áreas de toque a identificadores de acción.
• listTemplateEvents permite que la aplicación procese acciones originadas en el widget más tarde.

El tiempo de ejecución resuelve sustitutos como {{state.title}}, {{timers.rest.remainingText}}y {{meta.template.kind}} antes de que el puente nativo devuelva una superficie para la renderización.

Títulos de sección

Las sesiones de tipo full-native son para widgets que renderizan su propia interfaz de usuario de manera nativa:

• startWidgetSession crea un estado compartido y metadatos para el widget nativo code.
• updateWidgetSession combina o reemplaza el estado y marca la sesión como activa nuevamente.
• stopWidgetSession registra un estado final y marca la sesión como detenida.
• sendWidgetMessage coloca en cola el trabajo de aplicación a widget o widget a aplicación.
• acknowledgeWidgetMessages marca los mensajes como recibidos.
• completeWidgetMessage almacena una respuesta o un error para las tareas asíncronas.

Los mensajes son idempotentes después de la finalización: repetir un mensaje completado o fallido devuelve el resultado existente en lugar de sobrescribirlo.

Público API

Método	Descripción
areActivitiesSupported	Verificar si la puente de actividad de plantilla nativa puede ejecutarse en el dispositivo actual.
startTemplateActivity	Persistir una plantilla de actividad SVG y iniciar la puente de actividad nativa Live.
updateTemplateActivity	Reemplazar la definición de actividad, el estado o la URL abierta.
endTemplateActivity	Finalizar una actividad en ejecución y opcionalmente persistir una instantánea de estado de una sola vez.
performTemplateAction	Ejecutar parches declarativos, mutaciones de marco, mutaciones de temporizador y registro de eventos.
getTemplateActivity	Leer una actividad de plantilla almacenada.
listTemplateActivities	Listar todas las actividades de plantilla almacenadas.
listTemplateEvents	Leer eventos de acción emitidos por acciones de plantilla.
acknowledgeTemplateEvents	Marcar eventos de plantilla como procesados.
startWidgetSession	Iniciar una sesión de widget nativo completa respaldada por un estado JSON compartido.
updateWidgetSession	Unir o reemplazar el estado de sesión de widget nativo completa.
stopWidgetSession	Detener una sesión de widget nativo completa y opcionalmente persistir el estado final.
getWidgetSession	Leer una sesión de widget nativo completa.
listWidgetSessions	Listar todas las sesiones de widget nativo completa.
sendWidgetMessage	Colar un mensaje entre la aplicación y el widget nativo code.
listWidgetMessages	Listar mensajes de puente en cola.
acknowledgeWidgetMessages	Marcar mensajes de puente como reconocidos.
completeWidgetMessage	Concluir o fallar un mensaje de puente asíncrono.
getPluginVersion	Devolver el marcador de versión de la implementación de plataforma.

Piezas Nativas

El plugin también envía ayudantes nativos para objetivos de widget:

• CapgoTemplateWidgetBridge resuelve una superficie de plantilla SVG en svg, frameId, hotspots, y metadatos.
• CapgoTemplateActionIntent conecta botones de widget interactivos de iOS a acciones de plantilla.
• CapgoNativeWidgetBridge carga sesiones y mensajes nativos completos desde el widget code.
• Los ayudantes de plantilla de Android proporcionan comportamiento de receptor de acción y puente de widget coincidente.

Fuente de Verdad

La referencia API se sincroniza desde src/definitions.ts en el repositorio del plugin.

Sigue adelante desde @capgo/capacitor-kit-de-widget

Si estás utilizando @capgo/capacitor-kit-de-widget para planificar la automatización de CI/CD, conecta con Usando @capgo/capacitor-kit-de-widget para la capacidad nativa en Usando @capgo/capacitor-kit-de-widget, Capgo CI/CD para el flujo de trabajo del producto en Capgo CI/CD, Capgo Construcción nativa para el flujo de trabajo del producto en Capgo Construcción nativa, Capgo Integraciones para el flujo de trabajo del producto en Capgo Integraciones, y Integración CI/CD para los detalles de implementación en Integración CI/CD