Getting Started

安装

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-widget-kit` plugin in my project.

如果您更喜欢手动设置，请按照以下命令安装插件并遵循以下平台特定的说明：

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

导入

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

iOS 设置

为 Live 活动和 WidgetKit 扩展配置原生应用：

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

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

标题为“检查支持”

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

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

选项 1：SVG 模板活动

当小部件可以渲染解析的 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' },
});

框架变异

框架变异会将当前框架id写入状态。一个布局可以通过读取它来获取它 frameIdPath.

操作	行为
set	设置一个特定的框架id。普通字符串被视为字面框架id; {{...}} 模板首先被解析。
next	移动到下一个框架 frameIds 或声明的帧 surface.
previous	移动到上一个帧。
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：全本地小部件会话

在小部件 UI 使用本机 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 { sessions } = await CapgoWidgetKit.listWidgetSessions();
console.log('Known widget sessions:', sessions);

异步小部件消息

Messages 覆盖需要稍后回复的工作，例如一个小部件要求应用程序同步数据。

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 组

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

真实来源

完整类型引用存储在插件仓库中 src/definitions.ts.

继续从Getting Started

如果您正在使用 Getting Started 为了native插件工作的准备， 使用@capgo/capacitor-widget-kit 在使用@capgo/capacitor-widget-kit时， Capgo插件目录 在Capgo插件目录中， Capacitor由Capgo提供的插件 在Capacitor由Capgo提供的插件中， 添加或更新插件 添加或更新插件的详细信息， Ionic企业版插件替代方案 在Ionic企业版插件替代方案中，