@capgo/capacitor-widget-kit
Capacitor bridge for an iOS-first WidgetKit / Live Activities plugin.
Overview
Section titled “Overview”Capacitor bridge for an iOS-first WidgetKit / Live Activities plugin.
Core Capabilities
Section titled “Core Capabilities”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.
Public API
Section titled “Public API”| Method | Description |
|---|---|
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. |
performTemplateAction | Execute one declarative action and record the resulting event. |
getTemplateActivity | Read one activity back from the shared store. |
listTemplateActivities | List every activity currently known by the plugin. |
listTemplateEvents | List stored action events so the app can react to widget interactions later. |
acknowledgeTemplateEvents | Mark previously processed events as acknowledged. |
getPluginVersion | Return the platform implementation version marker. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-widget-kit.