使用 @capgo/capacitor-widget-kit

@capgo/capacitor-widget-kit 让一个 Capacitor 应用程序驱动 WidgetKit 和 Live Activity 体验的两种方式:

渲染解析的 SVG 模板表面，支持帧切换、点击热点和暂停/播放计时器。
在应用程序和小部件共享 JSON 会话状态和异步消息时，保持小部件完全原生。

安装

bun add @capgo/capacitor-widget-kit
bunx cap sync

何时使用 SVG 模板

在小部件表面可以用 SVG 描述时使用 SVG 模板。应用程序存储一个模板定义，原生桥梁解析占位符，小部件点击可以后续改变状态。

适合的场景包括运动计时器、送货状态卡、体育比分或任何紧凑的 UI，其中切换到命名帧足够。

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

const { activity } = await CapgoWidgetKit.startTemplateActivity({
  activityId: 'session-1',
  state: {
    title: 'Chest Day',
    frame: 'summary',
    restDurationMs: 90000,
  },
  definition: {
    id: 'workout-card',
    timers: [{ id: 'rest', durationPath: 'state.restDurationMs' }],
    actions: [
      {
        id: 'next-frame',
        frameMutations: [{ op: 'next', path: 'frame', surface: 'lockScreen' }],
      },
      {
        id: 'toggle-rest',
        timerMutations: [{ op: 'toggle', timerId: 'rest' }],
      },
    ],
    layouts: {
      lockScreen: {
        width: 100,
        height: 40,
        frameIdPath: 'state.frame',
        frames: [
          {
            id: 'summary',
            hotspots: [{ id: 'switch', actionId: 'next-frame', x: 0, y: 0, width: 100, height: 40 }],
            svg: `<svg viewBox="0 0 100 40"><text x="6" y="22">{{state.title}}</text></svg>`,
          },
          {
            id: 'timer',
            hotspots: [{ id: 'pause-play', actionId: 'toggle-rest', x: 0, y: 0, width: 100, height: 40 }],
            svg: `<svg viewBox="0 0 100 40"><text x="6" y="22">{{timers.rest.remainingText}}</text></svg>`,
          },
        ],
      },
    },
  },
});

在 App 中处理小部件操作

小部件操作会被保存为事件。在 app 恢复或背景同步步骤后，读取和确认它们。

const { events } = await CapgoWidgetKit.listTemplateEvents({
  activityId: activity.activityId,
  unacknowledgedOnly: true,
});

for (const event of events) {
  console.log(event.actionId, event.state, event.timers);
}

await CapgoWidgetKit.acknowledgeTemplateEvents({ activityId: activity.activityId });

何时使用全本机会话

在 Swift、Kotlin 或 Java 中直接构建小部件 UI 时使用全本机会话。 Capacitor仍然启动和停止会话，保持共享状态最新，并在 app 和小部件之间排队工作code。

const { session } = await CapgoWidgetKit.startWidgetSession({
  widgetId: 'native-session-1',
  kind: 'workout-controls',
  state: { isRunning: true, selectedSetId: 'set-1' },
  metadata: { accent: '#00d69c' },
});

await CapgoWidgetKit.updateWidgetSession({
  widgetId: session.widgetId,
  merge: true,
  state: { isRunning: false },
});

在小部件和 app 之间排队异步工作

可以从 app 流向小部件或从小部件流向 app。消息会等待确认和完成，直到被确认和完成。

const { message } = await CapgoWidgetKit.sendWidgetMessage({
  widgetId: session.widgetId,
  direction: 'widgetToApp',
  name: 'syncWorkoutSet',
  payload: { setId: 'set-1' },
  expectsResponse: true,
});

await CapgoWidgetKit.acknowledgeWidgetMessages({ messageIds: [message.messageId] });

await CapgoWidgetKit.completeWidgetMessage({
  messageId: message.messageId,
  response: { synced: true },
});

如果任务失败，请将错误作为完成消息：

await CapgoWidgetKit.completeWidgetMessage({
  messageId: message.messageId,
  error: 'Sync failed',
});

清洁停止会话

await CapgoWidgetKit.endTemplateActivity({
  activityId: activity.activityId,
  state: { title: 'Workout complete', frame: 'summary' },
});

await CapgoWidgetKit.stopWidgetSession({
  widgetId: session.widgetId,
  state: { isRunning: false },
});

iOS 小部件和 Live 活动的本机设置注意事项

为 app 和小部件扩展目标配置一个 App 组，并在两个文件中设置 CapgoWidgetKitAppGroup 在交互式按钮中，需要一个小部件扩展来连接插件提供的本机桥接和动作意图。 Info.plist __CAPGO_KEEP_0__和__CAPGO_KEEP_1__

全局参考

GitHub: https://github.com/Cap-go/capacitor-widget-kit/
文档：/docs/plugins/widget-kit/

Widget Kit

关于 Widget Kit 的教程