Skip to content

Swift version of WebViewJavascriptBridge with more simplified and friendly methods to handle messages between Swift and JS in UIWebViews

License

Notifications You must be signed in to change notification settings

lowip/SwiftWebViewBridge

 
 

Repository files navigation

SwiftWebViewBridge

ObjC ObjC pod

Swift version of WebViewJavascriptBridge with more simplified, friendly methods to send messages between Swift and JS in UIWebViews.


  1. Installation
  2. Preview
  3. Requirements
  4. How to use it
  5. Dig it up

Installation

####Cocoapods(iOS8+)

If your Swift version is below 3.0, Please use tag 0.1.5 release!

  1. Add these lines below to your Podfile

    platform :ios, '8.0'
    use_frameworks!	
    pod 'SwiftWebViewBridge', '~> 0.2.0'
    
  2. Install the pod by running pod install

  3. import SwiftWebViewBridge

####Manually(iOS7+)

Drag SwiftWebViewBridge.swift file to your project.

Preview

preview preview2

Requirements

  1. Xcode7.0+
  2. iOS7.0+

####Optional

SwiftyJSON: SwiftyJSON makes it easy to deal with JSON data in Swift.

The communication between Swift and JS depends on JSON messages.The param jsonData you got in closure is deserlized by method below.You could simply pass it in JSON(jsonObject) designated initializer of SwiftJSON

NSJSONSerialization.JSONObjectWithData(serilizedData, .AllowFragments)
func JSONObjectWithData(_ data: NSData, options opt: NSJSONReadingOptions) throws -> AnyObject

How to use it:

###General

  1. initialize a bridge with defaultHandler
  2. register handlers to handle different events
  3. send data / call handler on both sides

###For Swift

#####func bridge(_ webView: UIWebView, defaultHandler handler: SWVBHandler?) -> SwiftWebViewBridge Generate a bridge with associated webView and default handler to deal with messages from js without specifying designated handler

let bridge = SwiftJavaScriptBridge.bridge(webView, defaultHandler: { data, responseCallback in
	print("Swift received message from JS: \(data)")
	responseCallback("Swift already got your msg, thanks")
}) 

#####func registerHandlerForJS(handlerName name: String, handler:SWVBHandler) Register a handler for JavaScript calling

// take care of retain cycle!
bridge.registerHandlerForJS(handlerName: "getSesionId", handler: { [unowned self] data, responseCallback in
	let sid = self.session            
	responseCallback(["msg": "Swift has already finished its handler", "returnValue": [1, 2, 3]])
})

#####func sendDataToJS(_ data: SWVBData) Simply Sent data to JS

bridge.sendDataToJS(["msg": "Hello JavaScript", "gift": ["100CNY", "1000CNY", "10000CNY"]])

#####func sendDataToJS(_ data: SWVBData, responseCallback: SWVBResponseCallBack?) Send data to JS with callback closure

bridge.sendDataToJS("Did you received my gift, JS?", responseCallback: { data in
	print("Receiving JS return gift: \(data)")
})

#####func callJSHandler(_ handlerName: String?, params: SWVBData?, responseCallback: SWVBResponseCallBack?) Call JavaScript registered handler

bridge.callJSHandler("alertReceivedParmas", params: ["msg": "JS, are you there?"], responseCallback: nil)

#####typealias mentioned above

/// 1st param: responseData to JS
public typealias SWVBResponseCallBack = (NSDictionary) -> Void
/// 1st param: jsonData sent from JS; 2nd param: responseCallback for sending data back to JS
public typealias SWVBHandler = (AnyObject, SWVBResponseCallBack) -> Void
public typealias SWVBData = [String: Any]

#####logging for debug

SwiftWebViewBridge.logging = false  //default true

###For JavaScript

#####function init(defaultHandler)

bridge.init(function(message, responseCallback) {
	log('JS got a message', message)
	var data = { 'JS Responds' : 'Message received = )' }
	responseCallback(data)
})

#####function registerHandlerForSwift(handlerName, handler)

bridge.registerHandlerForSwift('alertReceivedParmas', function(data, responseCallback) {
	log('ObjC called alertPassinParmas with', JSON.stringify(data))
	alert(JSON.stringify(data))
	var responseData = { 'JS Responds' : 'alert triggered' }
	responseCallback(responseData)
})

#####function sendDataToSwift(data, responseCallback)

bridge.sendDataToSwift('Say Hello Swiftly to Swift')
bridge.sendDataToSwift('Hi, anybody there?', function(responseData){
	alert("got your response: " + JSON.stringify(responseData))
})

#####function callSwiftHandler(handlerName, data, responseCallback)

SwiftWebViewBridge.callSwiftHandler("printReceivedParmas", {"name": "小明", "age": "6", "school": "GDUT"}, function(responseData){
	log('JS got responds from Swift: ', responseData)
})

Dig it up

The source code have very detailed comments, this will help you to dig it up if you are interesting in how swift and javascript communicate with each other. What's more, you can find the unminified javascript file in UnminifiedJavascript document.

About

Swift version of WebViewJavascriptBridge with more simplified and friendly methods to handle messages between Swift and JS in UIWebViews

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 73.2%
  • JavaScript 12.3%
  • HTML 12.1%
  • Ruby 2.4%