https://github.com/tmarkovski/bridgecommander
https://github.com/tmarkovski/bridgecommander
ios native-bridge swift wkwebview
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/tmarkovski/bridgecommander
- Owner: tmarkovski
- License: mit
- Created: 2016-11-21T10:20:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-05T11:39:15.000Z (over 9 years ago)
- Last Synced: 2025-04-06T11:36:36.441Z (about 1 year ago)
- Topics: ios, native-bridge, swift, wkwebview
- Language: Swift
- Size: 43 KB
- Stars: 25
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BridgeCommander
[](https://travis-ci.org/tmarkovski/BridgeCommander)
A wrapper library for iOS apps that provides easy to use functions for briding the communication between the native runtime and javascript runtime hosted in a WKWebView. The library wraps the functionality provided by `WKUserContentController` and embeds a javascript library that exposes promise style functions.
## Usage
In Swift, create a `BridgeCommander` instance and start adding commands. Use `send` function to provide result back or `error` to pass back an error result.
```swift
let commander = BridgeCommander(webView)
commander.add("echo") { command in
command.send(args: "You said: \(command.args)")
}
```
In JavaScript, invoke this command as
```javascript
BridgeCommander.call("echo", "Hello!")
.then(function(result) { console.log(result); })
.catch(function(error) { console.log(error); });
```
That's it!
## Installation
### Plain old copy/paste
The simplest way would be to add `BridgeCommander.swift` and `BridgeCommander.js` to your xcode project. Make sure to update the javascript file reference inside the code if you rename the files or place them in separate folders. Do not reference the js file in your web app, it will be automatically available everywhere.
### Using Carthage
This is a clean and fast way to use this as a library in your project. If you're unfamiliar with Carthage, [read Ray's article](https://www.raywenderlich.com/109330/carthage-tutorial-getting-started) on using it