Widget Kit

使用 @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 模板时，widget 表面可以用 SVG 描述。应用程序存储一个模板定义，native 桥解析占位符，小部件点击可以在后续状态中改变。

适合的场景包括运动计时器、送货状态卡、体育比分或任何紧凑的 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>`,
          },
        ],
      },
    },
  },
});

在应用程序中处理小部件动作

小部件动作被持久化为事件。读取并确认它们，当应用程序恢复或在后台同步步骤后。

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 });

何时使用全本地会话

使用全本地会话时，widget UI 更好地直接在 Swift、Kotlin 或 Java 中构建。 Capacitor 还是启动和停止会话，保持共享状态最新，并在应用程序和小部件之间排队工作 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 },
});

在小部件和应用程序之间排队异步工作

消息可以从应用程序流向小部件或小部件流向应用程序。它们保持待处理状态，直到确认并完成。

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 WidgetKit 和 Live Activities，请在应用程序和小部件扩展目标上配置一个 App Group，并在两个文件中设置 CapgoWidgetKitAppGroup 互动按钮需要一个小部件扩展，连接插件提供的原生桥接和动作意图 Info.plist 全参考

__CAPGO_KEEP_0__

• https://GitHub.com/Cap-go/__CAPGO_KEEP_1__-widget-kit/ https://github.com/Cap-go/capacitor-widget-kit/
• 继续使用 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-widget-kit

Keep going from Using @capgo/capacitor-widget-kit

如果您正在使用 使用 @capgo/capacitor-widget-kit 来规划原生插件工作，连接它与 @capgo/capacitor-widget-kit 查看 @capgo/capacitor-widget-kit 开始 查看开始 Capgo 插件目录 查看 Capgo 插件目录 Capacitor 由 Capgo 查看 Capacitor 由 Capgo 添加或更新插件 为添加或更新插件的实现细节。