WebKit Native Bridge

A typed request/response bridge for JavaScript running inside a WebKit host application. The JavaScript side posts messages to window.webkit.messageHandlers, while native C++ code handles those messages and dispatches response events back into the page.

The package is useful when a Web UI is embedded in a native application and needs a reliable contract for commands, requests, successful payloads, native errors, and transport failures.

Categories

• Functions — bridge creation, response normalization, and error helpers.
• Classes — runtime errors for unavailable and disposed bridge states.
• Bridge types — response, success, failure, and normalized error types.
• Native types — request maps, method groups, request bodies, response bodies, and event details.

Native integration

JavaScript sends messages to the configured WebKit handler. Native C++ code should parse the message, perform the requested action, and dispatch a CustomEvent with the same request ID so the pending JavaScript promise can resolve.

Quick example

import { createNativeBridge } from '@almighty-shogun/webkit-native-bridge'

type Requests = {
    ping: { body: void; response: 'pong' }
}

const bridge = createNativeBridge<Requests>();
const response = await bridge.request('ping');

Continue with installation or jump to a category from the sidebar.