Skip to content

@capgo/capacitor-widget-kit

Capacitor bridge for an iOS-first WidgetKit / Live Activities plugin.

Capacitor bridge for an iOS-first WidgetKit / Live Activities plugin.

  • areActivitiesSupported - Check whether the native template activity bridge can run on the current device.
  • startTemplateActivity - Persist a generic SVG template activity and start the matching native Live Activity bridge.
  • updateTemplateActivity - Replace part or all of the stored activity definition/state.
  • endTemplateActivity - End a running activity while optionally persisting one last state snapshot.
MethodDescription
areActivitiesSupportedCheck whether the native template activity bridge can run on the current device.
startTemplateActivityPersist a generic SVG template activity and start the matching native Live Activity bridge.
updateTemplateActivityReplace part or all of the stored activity definition/state.
endTemplateActivityEnd a running activity while optionally persisting one last state snapshot.
performTemplateActionExecute one declarative action and record the resulting event.
getTemplateActivityRead one activity back from the shared store.
listTemplateActivitiesList every activity currently known by the plugin.
listTemplateEventsList stored action events so the app can react to widget interactions later.
acknowledgeTemplateEventsMark previously processed events as acknowledged.
getPluginVersionReturn the platform implementation version marker.

This reference is synced from src/definitions.ts in capacitor-widget-kit.