@capgo/capacitor-위젯 키트

개요

@capgo/capacitor-widget-kit Capacitor 앱은 두 가지 방법으로 위젯과 라이브 활동을 제어합니다.

• SVG 템플릿 활동: SVG로 위젯 키트 표면을 정의하고 탭으로 이름이 지정된 프레임을switch, 일시 중단/재생 타이머를 실행하고 JSON 상태를 변형하고 앱에서 액션 이벤트를 수집합니다.
• 전체 네이티브 위젯 세션: 위젯 UI를 완전히 스위프트/코틀린/자바로 유지하면서 Capacitor이 공유된 JSON 상태와 앱에서 위젯으로 또는 위젯에서 앱으로의 메시지를 소유합니다.

SVG 템플릿을 사용하여 위젯이 해결된 SVG 문자열로 렌더링될 수 있는 경우 사용하십시오. 전체 네이티브 세션을 사용하여 위젯이 커스텀 네이티브 UI가 필요하지만 여전히 시작, 중단, 동기화 상태 또는 앱에서 비동기 작업을 완료하도록 요청해야 할 경우 사용하십시오.

Demo

위젯 템플릿 흐름

Choose A Mode

모드	Best for	Main APIs
SVG 템플릿 활동	Live Activities or widget surfaces that render from SVG output	startTemplateActivity, performTemplateAction, listTemplateEvents
Full-native widget session	Native-rendered widgets that need shared state and async jobs	startWidgetSession, updateWidgetSession, sendWidgetMessage

두 가지 모드도 동일한 앱에 존재할 수 있습니다. 예를 들어, 운동 앱은 SVG Live Activity를 사용하여 빠른 프레임/타이머 제어를 위해 SVG Live Activity를 사용하고, 홈 스크린 위젯에 richer native 레이아웃을 위한 full-native widget session을 사용할 수 있습니다.

SVG 템플릿 기능

SVG 템플릿은 인터랙티브 위젯 표면에 필요한 조각을 포함합니다:

• frames hold named SVG variants such as summary, timer, or details.
• frameMutations 스위치, 토글, 또는 핫스팟 액션 후 프레임을 순환합니다.
• timerMutations 시작, 일시정지, 재개, 토글, 초기화, 중단, 또는 타이머 시간을 변경합니다.
• patches JSON 상태를.literal 값, 템플릿, 타임스탬프, 증가치, 토글, 또는 삭제 연산을 사용하여 업데이트합니다.
• hotspots 터치 영역을 액션 식별자와 매핑합니다.
• listTemplateEvents 앱이 위젯에서 기원한 액션을 나중에 처리할 수 있도록합니다.

The runtime resolves placeholders like __CAPGO_KEEP_0__ {{state.title}}, {{timers.rest.remainingText}}, and __CAPGO_KEEP_0__ {{meta.template.kind}} 자연스러운 UI 렌더링을 위해 위젯이 자체적으로 UI를 렌더링하는 위젯에 사용됩니다.

자연스러운 UI 렌더링을 위해 위젯이 자체적으로 UI를 렌더링하는 위젯에 사용됩니다.

자연스러운 UI 렌더링을 위해 위젯이 자체적으로 UI를 렌더링하는 위젯에 사용됩니다.

• startWidgetSession creates shared state and metadata for native widget code.
• updateWidgetSession __CAPGO_KEEP_0__
• stopWidgetSession __CAPGO_KEEP_0__
• sendWidgetMessage __CAPGO_KEEP_0__
• acknowledgeWidgetMessages __CAPGO_KEEP_0__
• completeWidgetMessage __CAPGO_KEEP_0__

__CAPGO_KEEP_0__

API

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
areActivitiesSupported	__CAPGO_KEEP_0__
startTemplateActivity	__CAPGO_KEEP_0__
updateTemplateActivity	__CAPGO_KEEP_0__을 정의, 상태 또는 열 URL로 대체합니다.
endTemplateActivity	__CAPGO_KEEP_0__를 실행 중단하고 optionally 마지막 상태 스냅샷을 저장합니다.
performTemplateAction	선언적 패치, 프레임 변형, 타이머 변형 및 이벤트 로깅을 실행합니다.
getTemplateActivity	저장된 템플릿 활동을 하나 읽습니다.
listTemplateActivities	저장된 템플릿 활동을 모두 목록화합니다.
listTemplateEvents	템플릿 액션으로부터 발생한 액션 이벤트를 읽습니다.
acknowledgeTemplateEvents	템플릿 이벤트를 처리한 것으로 표시합니다.
startWidgetSession	공유 JSON 상태를 기반으로 한 전체 네이티브 위젯 세션을 시작합니다.
updateWidgetSession	전체 네이티브 위젯 세션 상태를 병합하거나 대체합니다.
stopWidgetSession	전체 네이티브 위젯 세션을 중단하고 optionally 최종 상태를 저장합니다.
getWidgetSession	전체 네이티브 위젯 세션을 하나 읽습니다.
listWidgetSessions	전체 네이티브 위젯 세션을 모두 목록화합니다.
sendWidgetMessage	code를 앱과 네이티브 위젯 사이에 메시지를 큐합니다.
listWidgetMessages	queued bridge 메시지 목록을 표시합니다.
acknowledgeWidgetMessages	bridge 메시지의 확인을 표시합니다.
completeWidgetMessage	async bridge 메시지를 완료하거나 실패합니다.
getPluginVersion	플랫폼 구현 버전 마커를 반환합니다.

네이티브 피스

이 플러그인은 위젯 대상에 대한 네이티브 헬퍼도 제공합니다.

• CapgoTemplateWidgetBridge SVG 템플릿 표면을 svg, frameId, hotspots, 및 메타데이터로 해결합니다.
• CapgoTemplateActionIntent iOS 위젯 버튼을 템플릿 액션과 연결합니다.
• CapgoNativeWidgetBridge 네이티브 위젯 code에서 네이티브 세션과 메시지를 로드합니다.
• 안드로이드 템플릿 헬퍼는 액션 수신자와 위젯 브리지를 위한 동등한 동작을 제공합니다.

진실의 근원

API 참조는 플러그인 저장소에서 동기화됩니다. src/definitions.ts 플러그인 저장소에서 __CAPGO_KEEP_0__ 참조를 동기화합니다.

섹션 제목 “capgo/capacitor-위젯 키트에서 계속하기”

__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-위젯 키트 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-위젯 키트 @capgo/capacitor-위젯 키트 @capgo/capacitor-위젯 키트 CI/CD 자동화 계획을 위해 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-위젯 키트를 사용 중이라면 자연스러운 네이티브 기능을 위해 @capgo/capacitor-위젯 키트를 사용합니다. 자연스러운 네이티브 기능을 위해 @capgo/capacitor-위젯 키트를 사용합니다. Capgo CI/CD Capgo CI/CD를 위한 제품 워크플로우 Capgo Native Builds Capgo Native Builds를 위한 제품 워크플로우 Capgo Integrations Capgo Integrations 및 제품 워크플로우 CI/CD Integration CI/CD Integration 구현 세부 사항