Installation

Add the libraryCopy Anchor Link

Add one dependency to commonMain.dependencies in your module's build.gradle.kts:

implementation("io.github.bernaferrari:kmpwright-core:0.0.1")

Gradle selects the matching platform variant. Your project must include mavenCentral() in its repositories. For a complete Gradle example, see Kotlin Multiplatform below.

The Kotlin/JS artifact supports the website demo's browser bridge. See the capability matrix for backend differences.

Public packages are com.bernaferrari.kmpwright.core and com.bernaferrari.kmpwright.compose.

Minimum versionsCopy Anchor Link

Video recording on the JVM also needs FFmpeg on PATH.

Kotlin MultiplatformCopy Anchor Link

Add the core to commonMain. Gradle picks the right Android, iOS or JVM variant per target.

// build.gradle.kts
repositories { mavenCentral() }

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("io.github.bernaferrari:kmpwright-core:0.0.1")
        }
        androidMain.dependencies {
            // Optional: Compose WebView wrapper (Android only).
            implementation("io.github.bernaferrari:kmpwright-compose:0.0.1")
        }
    }
}

Your shared code then works with Browser, Page and Locator. Each platform source set creates the PlatformContext (AndroidPlatformContext, IOSPlatformContext, JvmPlatformContext) because those wrap platform objects.

Android-only appCopy Anchor Link

// app/build.gradle.kts
dependencies {
    implementation("io.github.bernaferrari:kmpwright-core:0.0.1")
    implementation("io.github.bernaferrari:kmpwright-compose:0.0.1") // optional
}

Declare network access in your AndroidManifest.xml. The library does not add it for you:

<uses-permission android:name="android.permission.INTERNET" />

To inspect the automated WebView from chrome://inspect during development, call WebView.setWebContentsDebuggingEnabled(true) (the sample app does this).

iOSCopy Anchor Link

You have two options.

Kotlin Multiplatform. Add the dependency to commonMain (above) and use KMPwright from iosMain or shared code. Your shared framework exports whatever you choose; the KMPwright API itself is Kotlin, so drive it from Kotlin code.

Swift/Xcode via XCFramework. You can build a static KmpwrightCore.xcframework (module name KmpwrightCore) from source. CocoaPods distribution is not supported:

From source, the same XCFramework is produced by:

./gradlew :kmpwright-core:packageKmpwrightCoreReleaseXCFramework
# output: kmpwright-core/build/XCFrameworks/release/KmpwrightCore.xcframework

See docs/releasing.md for the verification steps.

JVMCopy Anchor Link

// build.gradle.kts
dependencies {
    implementation("io.github.bernaferrari:kmpwright-core:0.0.1")
}

On the JVM, KMPwright talks CDP to Chromium. Either point launchBrowser at a Chrome/Chromium executable, connect to an existing ws://…/devtools/browser/… endpoint, or use a cloud provider. See the JVM platform page.

Threading rulesCopy Anchor Link

KMPwright's API is suspend and can be called from any dispatcher, but the mobile WebViews themselves are single-threaded.

NextCopy Anchor Link