Skip to content

🔥 An iOS bridge for sending messages between Obj-C and JavaScript in WKWebViews.

Notifications You must be signed in to change notification settings

laole918/WKWebViewJavascriptBridge

Repository files navigation

WKWebViewJavascriptBridge

CocoaPods

This project is inspired by marcuswestin/WebViewJavascriptBridge and Lision/WKWebViewJavascriptBridge!

Android Java : https://github.com/laole918/JsBridge

What Can WKWebViewJavascriptBridge Do?

You can write hybrid modules in just a few lines of code by using WKWebViewJavascriptBridge without the need to be concerned with the underlying messaging implementation.

Features

  • Multi-end Consistency: This iOS Obj-C version project is a mirror of marcuswestin/WebViewJavascriptBridge(Obj-C) and Lision/WKWebViewJavascriptBridge(Swift), so they have the same API design, native code, and the Javascript code is exactly the same.
  • High Performance: The messaging performance is higher than intercept requests.
  • High Speed: No need to consider alert box safety timeout.
  • Lightweight: This framework contains only 3 files.
  • Non-intrusive: There is no need to make the webview class inherit from other base class.

Usage

1. Instantiate WKWebViewJavascriptBridge with a WebView:

self.bridge = [[WKWebViewJavascriptBridge alloc] initWithWebView:self.webView];

2. Register a Handler in Native, and Call a JS Handler:

[self.bridge registerHandler:@"testiOSCallback" handler:^(id data, WVJBResponseCallback responseCallback) {
    NSLog(@"testiOSCallback called: %@", data);
    responseCallback(@"Response from testiOSCallback");
}];
[self.bridge callHandler:@"testJavascriptHandler" data:@{@"foo": @"before ready"} responseCallback:nil];

3. Copy and Paste setupWKWebViewJavascriptBridge into Your JS:

function setupWKWebViewJavascriptBridge(callback) {
    if (window.WKWebViewJavascriptBridge) { return callback(WKWebViewJavascriptBridge); }
    if (window.WKWVJBCallbacks) { return window.WKWVJBCallbacks.push(callback); }
    window.WKWVJBCallbacks = [callback];
    /* For Android: Mock messageHandlers in iOS, Keep double-ended code consistent. */
    if (!window.webkit) {
        window.webkit = {};
        window.webkit.messageHandlers = {};
        window.webkit.messageHandlers.iOS_Native_InjectJavascript = window.iOS_Native_InjectJavascript;
        window.webkit.messageHandlers.iOS_Native_FlushMessageQueue = window.iOS_Native_FlushMessageQueue;
    }
    window.webkit.messageHandlers.iOS_Native_InjectJavascript.postMessage(null)
}

4. Finally, Call setupWKWebViewJavascriptBridge and then Use The Bridge to Register Handlers and Call Native Handlers:

setupWKWebViewJavascriptBridge(function(bridge) {
    /* Initialize your app here */
    bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) {
        console.log('iOS called testJavascriptHandler with', data)
        responseCallback({ 'Javascript Says':'Right back atcha!' })
    })
    bridge.callHandler('testiOSCallback', {'foo': 'bar'}, function(response) {
        console.log('JS got response', response)
    })
})

Installation

Cocoapods

  1. Add pod 'WKWebViewJavascriptBridge-ObjC', '~> 1.0.0' to your Podfile.
  2. Run pod install or pod update.
  3. Add #import "WKWebViewJavascriptBridge.h".

Manually

Either clone the repo and manually add the Files in WKWebViewJavascriptBridge.

Requirements

This framework requires iOS 9.0+ and Xcode 9.0+.