Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linusu/jsbridge
🔁 Bridge your JavaScript library for usage in Swift
https://github.com/linusu/jsbridge
hacktoberfest swift webkit
Last synced: about 1 month ago
JSON representation
🔁 Bridge your JavaScript library for usage in Swift
- Host: GitHub
- URL: https://github.com/linusu/jsbridge
- Owner: LinusU
- License: mit
- Created: 2018-03-16T11:36:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-11T12:26:40.000Z (over 3 years ago)
- Last Synced: 2024-12-24T15:25:45.816Z (about 1 month ago)
- Topics: hacktoberfest, swift, webkit
- Language: Swift
- Homepage:
- Size: 81.1 KB
- Stars: 110
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# JSBridge
Bridge your JavaScript library for usage in Swift 🚀
## Installation
### SwiftPM
```swift
dependencies: [
.package(url: "https://github.com/LinusU/JSBridge", from: "1.0.0"),
]
```
### Carthage
```text
github "LinusU/JSBridge" ~> 1.0.0
```
## Usage
**foobar.js:**
```js
window.Foobar = {
add (a, b) {
return a + b
},
greet (name) {
return `Hello, ${name}!`
},
async fetch (url) {
const response = await fetch(url)
const body = await response.text()
return { status: response.status, body }
}
}
```
**Foobar.swift:**
```swift
struct FetchResponse: Decodable {
let status: Int
let body: String
}
class Foobar {
static internal let bridge: JSBridge = {
let libraryPath = Bundle.main.path(forResource: "foobar", ofType: "js")!
let libraryCode = try! String(contentsOfFile: libraryPath)
return JSBridge(libraryCode: libraryCode)
}()
static func add(_ lhs: Int, _ rhs: Int) -> Promise {
return Foobar.bridge.call(function: "Foobar.add", withArgs: (lhs, rhs)) as Promise
}
static func greet(name: String) -> Promise {
return Foobar.bridge.call(function: "Foobar.greet", withArg: name) as Promise
}
static func fetch(url: URL) -> Promise {
return Foobar.bridge.call(function: "Foobar.fetch", withArg: url) as Promise
}
}
```
## API
### `JSBridge(libraryCode: String)`
Create a new `JSBridge` instance, with the supplied library source code.
The `libraryCode` should be a string of JavaScript that attaches one or more functions to the `window` object. These functions can then be called using the `call` method.
### `call(function: String) -> Promise`
Call a function without any arguments, ignoring the return value. The returned promise will settle once the function have completed running.
### `call(function: String) -> Promise`
Call a function without any arguments. The returned promise will settle with the return value of the function.
### `call(function: String, withArg: A) -> Promise`
Call a function with a single argument, ignoring the return value. The returned promise will settle once the function have completed running.
### `call(function: String, withArg: A) -> Promise`
Call a function with a single argument. The returned promise will settle with the return value of the function.
### `call(function: String, withArgs: (A, B, ...)) -> Promise`
Call a function with multiple arguments, ignoring the return value. The returned promise will settle once the function have completed running.
### `call(function: String, withArgs: (A, B, ...)) -> Promise`
Call a function with multiple arguments. The returned promise will settle with the return value of the function.
## iOS
To be able to use JSBridge on iOS, you need to give JSBridge a hook to your view hierarchy. Otherwise the `WKWebView` will get suspended by the OS, and your Promises will never settle.
This is accomplished by using the `setGlobalUIHook` function before instantiating any `JSBridge` instances.
**App:**
```swift
// Can be called from anywhere, e.g. your AppDelegate
JSBridge.setGlobalUIHook(window: UIApplication.shared.windows.first)
```
**App Extension:**
```swift
// From within your root view controller
JSBridge.setGlobalUIHook(viewController: self)
```
## Hacking
The Xcode project is generated automatically from `project.yml` using [XcodeGen](https://github.com/yonaskolb/XcodeGen). It's only checked in because Carthage needs it, do not edit it manually.
```sh
$ mint run yonaskolb/xcodegen
💾 Saved project to JSBridge.xcodeproj
```