メインコンテンツにジャンプ
プラグインに戻る
@capgo/capacitor-ウィジェットキット
チュートリアル
by github.com/Cap-go

ウィジェット キット

CapacitorでSVGテンプレート、タイマー、行動ホットスポットを使用してiOSウィジェットとライブアクティビティをビルドする

ガイド

ウィジェット キットのチュートリアル

Capgoの@capgo/capacitor-widget-kitを使用

CapacitorはiOS用のWidgetKit / Live Activities プラグインのためのブリッジです。

インストール

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

このプラグインが提供するもの

  • areActivitiesSupported - このプラグインは現在のデバイスでネイティブのテンプレートアクティビティブリッジを実行できるかどうかを確認します。
  • startTemplateActivity - 一般的なSVGテンプレートアクティビティを保存し、対応するネイティブのLive Activityブリッジを開始します。
  • updateTemplateActivity - ストレージされたアクティビティ定義/状態のうち一部または全てを置き換えます。
  • endTemplateActivity - 実行中のアクティビティを終了し、オプションで最後の状態スナップショットを保存します。

使用例

areActivitiesSupported

このプラグインは現在のデバイスでネイティブのテンプレートアクティビティブリッジを実行できるかどうかを確認します。

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

await CapgoWidgetKit.areActivitiesSupported();

startTemplateActivity

一般的なSVGテンプレートアクティビティを保存し、対応するネイティブのLive Activityブリッジを開始します。

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

await CapgoWidgetKit.startTemplateActivity({} as StartTemplateActivityOptions);

updateTemplateActivity

ストレージされたアクティビティ定義/状態のうち一部または全てを置き換えます。

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

await CapgoWidgetKit.updateTemplateActivity({} as UpdateTemplateActivityOptions);

endTemplateActivity

実行中のアクティビティを終了し、オプションで最後の状態スナップショットを保存する。

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

await CapgoWidgetKit.endTemplateActivity({} as EndTemplateActivityOptions);

フルリファレンス