开始使用

安装

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

导入

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

iOS 设置

尽可能使用 iOS 17+ 来实现交互式 Live 活动按钮。

• iOS 17+用于交互式Live活动按钮时尽可能使用。
• 添加到应用程序 NSSupportsLiveActivities 在使用 ActivityKit 时添加到应用程序 Info.plist 将相同的 App Group 添加到应用程序目标和小部件扩展目标
• 在两个文件中设置为共享 App Group 标识符
• 复制到剪贴板 CapgoWidgetKitAppGroup 检查支持 Info.plist 标题：检查支持

<key>CapgoWidgetKitAppGroup</key>
<string>group.app.capgo.widgetkit.exampleapp.widgetkit</string>

选项 1：SVG 模板 Activity

const { supported, reason } = await CapgoWidgetKit.areActivitiesSupported();

if (!supported) {
  console.log('WidgetKit bridge unavailable:', reason);
}

在两个文件中设置为共享 App Group 标识符

当小部件可以渲染解析的 SVG 时，请使用此模式。插件存储状态，解析占位符，应用点击操作，切换 SVG 框架，并保持计时器状态一致。

const { activity } = await CapgoWidgetKit.startTemplateActivity({
  activityId: 'workout-session-1',
  openUrl: 'myapp://workout/session-1',
  state: {
    title: 'Chest Day',
    frame: 'summary',
    restDurationMs: 90000,
  },
  definition: {
    id: 'workout-card',
    timers: [
      {
        id: 'rest',
        durationPath: 'state.restDurationMs',
      },
    ],
    actions: [
      {
        id: 'next-frame',
        eventName: 'widget.frame.changed',
        frameMutations: [
          {
            op: 'next',
            path: 'frame',
            surface: 'lockScreen',
          },
        ],
      },
      {
        id: 'toggle-rest',
        eventName: 'widget.timer.toggled',
        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>`,
          },
        ],
      },
    },
  },
});

从应用中运行动作

本机小部件可以通过热点/动作编程触发相同的动作。应用也可以直接运行它们：

await CapgoWidgetKit.performTemplateAction({
  activityId: activity.activityId,
  actionId: 'toggle-rest',
  sourceId: 'app-pause-play-button',
});

处理小部件事件

动作发出事件，使应用可以在启动或恢复后处理小部件交互：

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

for (const event of events) {
  console.log('Widget event:', event.eventName, event.state, event.timers);
}

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

更新或结束活动

await CapgoWidgetKit.updateTemplateActivity({
  activityId: activity.activityId,
  state: {
    title: 'Back Day',
    frame: 'summary',
    restDurationMs: 120000,
  },
});

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

Frame Mutations

Frame mutations 将当前 frame id 写入状态。一个布局可以通过读取它来获取它。 frameIdPath.

操作	行为
set	设置一个特定的 frame id。普通字符串被视为字面 frame id； {{...}} 模板首先被解析。
next	从 frameIds 或声明的 surface.
previous	向前移动到下一个 frame。
toggle	切换当前帧和前两帧之间，或切换到 frameId.

当变异具有已知可选择帧列表时，忽略无效的帧 ID，因此状态与渲染表面保持一致。

计时器变异

计时器变异目标一个已命名的计时器 definition.timers.

操作	行为
start / restart	使用当前持续时间从零开始。
pause	存储已过时间并清除 startedAt.
resume	恢复仅暂停的计时器。停止的计时器将保持停止状态，直到显式启动或重启。
toggle	暂停正在运行的计时器或恢复暂停的计时器。
reset	清除已过时间并返回空闲状态。
stop	清晰的运行进度并标记计时器停止。
setDuration	在持续时间变化后重新计算状态。

SVG 中可用的计时器绑定是 {{timers.<id>.remainingText}}, {{timers.<id>.elapsedMs}}, {{timers.<id>.status}},以及相关字段。

选项 2：全本地小部件会话

在本地 code 构建小部件 UI 时使用此模式。该插件为应用程序和小部件提供了一个共享的会话记录和消息队列。

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 { sessions } = await CapgoWidgetKit.listWidgetSessions();
console.log('Known widget sessions:', sessions);

异步小部件消息

消息涵盖需要稍后响应的工作，例如小部件要求应用程序同步数据。

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

要失败这项工作，传递 error 而不是 response:

await CapgoWidgetKit.completeWidgetMessage({
  messageId: message.messageId,
  error: 'Network unavailable',
});

completeWidgetMessage 是幂等的。如果消息已经完成或失败，重复调用返回现有消息快照。

停止一个本地会话

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

API 组

组	API
能力	areActivitiesSupported, getPluginVersion
SVG 活动生命周期	startTemplateActivity, updateTemplateActivity, endTemplateActivity, getTemplateActivity, listTemplateActivities
SVG 动作和事件	performTemplateAction, listTemplateEvents, acknowledgeTemplateEvents
原生小部件会话	startWidgetSession, updateWidgetSession, stopWidgetSession, getWidgetSession, listWidgetSessions
原生小部件消息	sendWidgetMessage, listWidgetMessages, acknowledgeWidgetMessages, completeWidgetMessage

真实来源

完整类型引用位于插件仓库中： src/definitions.ts.