Getting Started
설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 프롬프트를 복사합니다.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-webview-crash`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/webview-crash/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
설치
설치Capgo의 AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요:
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-webview-crash` plugin in my project.만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:
npm install @capgo/capacitor-webview-crashnpx cap syncImport
Importimport { WebViewCrash } from '@capgo/capacitor-webview-crash';권장된 복구 흐름
권장된 복구 흐름앱 시작 시 가능한 한 빨리 리스너를 연결하여 사용자가 계속 탐색하기 전에 복구된 런타임이 반응할 수 있도록 하세요:
import { WebViewCrash } from '@capgo/capacitor-webview-crash';
await WebViewCrash.addListener('webViewRestoredAfterCrash', async (info) => { console.log('Recovered after a WebView crash', info);
// Rehydrate critical state, reopen the correct screen, or prompt the user to retry. await WebViewCrash.clearPendingCrashInfo();});
await WebViewCrash.addListener('webViewRestoredAfterRestart', async (info) => { console.log('Recovered after a native WebView restart', info); await WebViewCrash.clearPendingCrashInfo();});
const pending = await WebViewCrash.getPendingCrashInfo();// Note: the listener callback may have already cleared the pending marker.if (pending.value) { console.log('Pending crash or restart marker', pending.value);}자연어 자동 재시작
권장된 복구 흐름재시작 옵션을 설정하여 JavaScript 런타임이 충돌하거나 로드되지 않은 경우에도 자연어 __CAPGO_KEEP_0__에서 결정이 유지되도록 하세요: capacitor.config.ts so the decision stays in native code even when the JavaScript runtime has crashed or has not loaded yet:
import type { CapacitorConfig } from '@capacitor/cli';import type { WebViewCrashPluginConfig } from '@capgo/capacitor-webview-crash';
const webViewCrash: WebViewCrashPluginConfig = { // Enabled by default. Keep this on for long-running apps. restartOnCrash: true,
// Use a 5-field cron schedule in the device local timezone. // Do not combine restartCron with an active restartIntervalMs. restartCron: '0 3 * * *',
// Optional delay before restarting after a crash. restartAfterCrashDelayMs: 0,};
const config: CapacitorConfig = { plugins: { WebViewCrash: webViewCrash, },};
export default config;사용 restartIntervalMs 다음과 같은 always-on 앱에서 사용하세요: 키오스크 화면, 제어실 대시보드,倉庫 스캐너, POS 터미널, 차량 태블릿 및 디지털 시그널. restartCron 다음과 같은 wall-clock 재시작에 사용하세요: 0 3 * * * 일정 재시작은 다음 표시자를 기록합니다: reason: 'periodicRestart'그리고 Android는 호스트 액티비티를 재생성하고 iOS는 Capacitor 브릿지 뷰를 재구성하여 새로운 WKWebView 생성합니다. native code.
정해진 간격 또는 cron 스케줄을 선택하세요. restartCron 지원합니다: *리스트, 범위 및 단계. restartCron 한 번에 두 가지 스케줄을 구성하지 마세요: native 초기화는 restartIntervalMs 가 설정되어且 0보다 클 때 치명적인 config 오류를 발생시킵니다.
수동 네이티브 재시작
수동 네이티브 재시작 섹션호출 restartWebView() 호출
await WebViewCrash.restartWebView();클립보드 복사 reason: 'manualRestart', resolves the current call, then asks native code to create a fresh WebView. Android recreates the host activity. iOS rebuilds the Capacitor bridge view so a new WKWebView , 현재 호출을 해제한 다음 네이티브 __CAPGO_KEEP_0__에게 새로운 WebView를 생성하도록 요청합니다. Android는 호스트 활동을 재생성하고 iOS는 __CAPGO_KEEP_1__ 브리지를 다시 빌드하여 새로운
API overview
API 개요getPendingCrashInfo
__CAPGO_KEEP_0__ 개요 섹션getPendingCrashInfo 섹션 null nothing이 처리 중이지 않습니다.
const pending = await WebViewCrash.getPendingCrashInfo();if (pending.value) { console.log(pending.value.platform, pending.value.reason);}clearPendingCrashInfo
clearPendingCrashInfo 제목_recovery 처리가 끝난 후 저장된 마커를 삭제합니다.
await WebViewCrash.clearPendingCrashInfo();simulateCrashRecovery
simulateCrashRecovery 제목QA 및 로컬 디버깅을 위해 실제 WebView가 충돌하지 않고 recovery 경로를 연습할 수 있도록 가짜 충돌 마커를 생성합니다.
const simulated = await WebViewCrash.simulateCrashRecovery();console.log(simulated.value);restartWebView
restartWebView 제목수동 재시작 마커를 저장하고 native code에게 새로운 WebView를 생성하도록 요청합니다.
await WebViewCrash.restartWebView();플랫폼 참고사항
플랫폼 참고 사항- Android는 플랫폼이 제공하는
onRenderProcessGone, 포함didCrash및rendererPriorityAtExit플랫폼이 제공할 때 - iOS는
webViewWebContentProcessDidTerminate및 현재 애플리케이션 상태를 제공할 때 추가합니다. - 수동 및 예약된 재시작은 새 WebView를 생성합니다. Android는 호스트 활동을 재생성하고 iOS는 Capacitor 브릿지 뷰를 재구성합니다.
- 예약된 재시작은
reason: 'periodicRestart'를 사용하고 수동 재시작은reason: 'manualRestart'. - 웹뷰는 실제 렌더러 충돌을 감지하지 않습니다. 웹 구현은 로컬 스토리지에서 동작을 시뮬레이션합니다.
타입 참조
Type referencePendingCrashInfoResult
PendingCrashInfoResultexport interface PendingCrashInfoResult { /** * Stored crash or restart metadata, or `null` when no marker is pending. */ value: WebViewCrashInfo | null;}WebViewCrashPluginConfig
WebViewCrashPluginConfigexport interface WebViewCrashPluginConfig { /** * Restart the WebView from native code when the renderer process dies. * * @default true */ restartOnCrash?: boolean;
/** * Fixed native interval, in milliseconds, for proactively replacing long-running WebViews. * * Set to `0` to disable interval restarts. Do not combine an active interval * with `restartCron`; native initialization fails fast when both schedules are configured. * * @default 0 */ restartIntervalMs?: number;
/** * Cron schedule for proactively replacing long-running WebViews. * * Uses standard 5-field cron syntax in the device local timezone: * `minute hour day-of-month month day-of-week`. * * Examples: * - `0 3 * * *` restarts every day at 03:00. * - `0,30 * * * *` restarts every 30 minutes. * * Do not combine this with an active `restartIntervalMs`; native initialization * fails fast when both schedules are configured. */ restartCron?: string;
/** * Delay, in milliseconds, before restarting after a crash. * * @default 0 */ restartAfterCrashDelayMs?: number;}WebViewCrashInfo
WebViewCrashInfoexport interface WebViewCrashInfo { /** * Platform that detected and stored the marker. */ platform: WebViewCrashPlatform;
/** * Unix timestamp in milliseconds for when the marker was written. */ timestamp: number;
/** * ISO-8601 version of `timestamp`. */ timestampISO: string;
/** * Platform-specific reason for the crash or restart marker. */ reason: WebViewCrashReason;
/** * Last known WebView URL when the marker was written. */ url?: string;
/** * Android-only hint from `RenderProcessGoneDetail.didCrash()`. */ didCrash?: boolean;
/** * Android-only renderer priority reported at exit. */ rendererPriorityAtExit?: number;
/** * iOS-only application state captured when the WebView process died. */ appState?: WebViewCrashAppState;}WebViewCrashPlatform
WebViewCrashPlatformexport type WebViewCrashPlatform = 'android' | 'ios' | 'web';WebViewCrashReason
WebViewCrashReasonexport type WebViewCrashReason = | 'renderProcessGone' | 'webContentProcessDidTerminate' | 'periodicRestart' | 'manualRestart' | 'simulated';WebViewCrashAppState
WebViewCrashAppStateexport type WebViewCrashAppState = 'active' | 'inactive' | 'background' | 'unknown';진실의 근원
‘진실의 근원’ 섹션이 페이지는 플러그인의 src/definitions.tsAPI의 공개 버전이 업스트림에서 변경될 때 다시 싱크를 실행하세요.
Getting Started에서 계속
‘Getting Started에서 계속’ 섹션native 미디어 및 인터페이스 동작을 계획하고 있는 경우 Getting Started Getting Started을 Using @capgo/capacitor-webview-crash Using @capgo/capacitor-webview-crash Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player, and @capgo/capacitor-video-player for the implementation detail in @capgo/capacitor-video-player.