Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Lision/WKWebViewJavascriptBridge
π A Bridge for Sending Messages between Swift and JavaScript in WKWebViews.
https://github.com/Lision/WKWebViewJavascriptBridge
bridge hybrid javascript js jsbridge swift webkit webviewjavascriptbridge wkwebview wkwebviewjavascriptbridge
Last synced: 5 days ago
JSON representation
π A Bridge for Sending Messages between Swift and JavaScript in WKWebViews.
- Host: GitHub
- URL: https://github.com/Lision/WKWebViewJavascriptBridge
- Owner: Lision
- License: mit
- Created: 2018-01-20T11:01:43.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-21T03:37:10.000Z (over 1 year ago)
- Last Synced: 2024-07-04T11:55:39.657Z (4 months ago)
- Topics: bridge, hybrid, javascript, js, jsbridge, swift, webkit, webviewjavascriptbridge, wkwebview, wkwebviewjavascriptbridge
- Language: Swift
- Size: 470 KB
- Stars: 1,245
- Watchers: 29
- Forks: 145
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - WKWebViewJavascriptBridge
README
[](https://github.com/apple/swift)Β
[](https://github.com/Carthage/Carthage)Β
[](https://raw.githubusercontent.com/Lision/WKWebViewJavascriptBridge/master/LICENSE)Β
[](https://www.apple.com/nl/ios/)Β
[](http://cocoadocs.org/docsets/WKWebViewJavascriptBridge)Β
[](https://travis-ci.org/Lision/WKWebViewJavascriptBridge)Β
[](http://cocoapods.org/pods/WKWebViewJavascriptBridge)
> [δΈζδ»η»](https://github.com/Lision/WKWebViewJavascriptBridge/blob/master/README_ZH-CN.md)
> This project is inspired by [WebViewJavascriptBridge](https://github.com/marcuswestin/WebViewJavascriptBridge)!
# 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.
# Why Only Support WKWebView?
### Advantages of WKWebView
It is well known that **WKWebView loads web pages faster and more efficiently than UIWebView**, and also **doesn't have as much memory overhead** for you.
Under the current timeline, most iOS apps only support iOS 9.0+.
### UIWebView Cross-Domain Access Vulnerability
The reason for the iOS platform cross-domain access vulnerability is due to UIWebView turning on the WebKitAllowUniversalAccessFromFileURLs and WebKitAllowFileAccessFromFileURLs options.
**WKWebView default allowFileAccessFromFileURLs and allowUniversalAccessFromFileURLs option is false.**
# Features
- **Swift Support:** Swift 3.2 ~ 5 Support.
- **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 WKWebView:
``` swift
bridge = WKWebViewJavascriptBridge(webView: webView)
```
### 2. Register a Handler in Native, and Call a JS Handler:
``` swift
bridge.register(handlerName: "testiOSCallback") { (parameters, callback) in
print("testiOSCallback called: \(String(describing: parameters))")
callback?("Response from testiOSCallback")
}
bridge.call(handlerName: "testJavascriptHandler", data: ["foo": "before ready"], callback: nil)
```
### 3. Copy and Paste setupWKWebViewJavascriptBridge into Your JS:
``` js
function setupWKWebViewJavascriptBridge(callback) {
if (window.WKWebViewJavascriptBridge) { return callback(WKWebViewJavascriptBridge); }
if (window.WKWVJBCallbacks) { return window.WKWVJBCallbacks.push(callback); }
window.WKWVJBCallbacks = [callback];
window.webkit.messageHandlers.iOS_Native_InjectJavascript.postMessage(null)
}
```
### 4. Finally, Call setupWKWebViewJavascriptBridge and then Use The Bridge to Register Handlers and Call Native Handlers:
``` js
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', '~> 1.2.0'` to your Podfile.
2. Run `pod install` or `pod update`.
3. Add `import WKWebViewJavascriptBridge`.
### Carthage
1. Add `github "Lision/WKWebViewJavascriptBridge" ~> 1.2.0` to your Cartfile.
2. Run `carthage update --platform ios`.
3. Add the `WKWebViewJavascriptBridge` framework to your project.
### Manually
Either clone the repo and manually add the Files in [WKWebViewJavascriptBridge](https://github.com/Lision/WKWebViewJavascriptBridge/tree/master/WKWebViewJavascriptBridge).
# Requirements
This framework requires `iOS 9.0+` and `Xcode 9.0+`.
# Contact
- Email: [email protected]
- Sina: [@Lision](https://weibo.com/5071795354/profile)
- Twitter: [@Lision](https://twitter.com/LisionChat)
# License
[](https://raw.githubusercontent.com/Lision/WKWebViewJavascriptBridge/master/LICENSE)
WKWebViewJavascriptBridge is provided under the MIT license. See LICENSE file for details.