Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/douking/stmscriptmessagehandler
A script message handler for wkwebview is used to communicate with js each other.
https://github.com/douking/stmscriptmessagehandler
javascript js scriptmessage webview wkscriptmessagehandler wkwebview wkwebview-javascript-bridge wkwebview-js
Last synced: 2 days ago
JSON representation
A script message handler for wkwebview is used to communicate with js each other.
- Host: GitHub
- URL: https://github.com/douking/stmscriptmessagehandler
- Owner: DouKing
- License: other
- Created: 2016-11-25T11:51:43.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-06-27T06:26:23.000Z (over 1 year ago)
- Last Synced: 2024-05-22T17:04:30.851Z (9 months ago)
- Topics: javascript, js, scriptmessage, webview, wkscriptmessagehandler, wkwebview, wkwebview-javascript-bridge, wkwebview-js
- Language: Objective-C
- Homepage:
- Size: 8.78 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://996.icu)
[](https://github.com/996icu/996.ICU/blob/master/LICENSE)
# STMScriptMessageHandler
The `STMScriptMessageHandler` is used to comunicate with js for `WKWebView`. It implements `WKScriptMessageHandler` and `WKScriptMessageHandlerWithReply` protocol. A `STMScriptMessageHandler` corresponding a js object. When your `WKWebView` add a `STMScriptMessageHandler`, the js side add a object on the window automatically. The handlerName of `STMScriptMessageHandler` is the js object's name.
## Features
- [x] Support multi message handlers
- [x] Support Promise
- [x] Compatible with `WebViewJavascriptBridge`
## Requirements
iOS 8.0+
## Usage
#### Native side
```objectivec
//When the native register a STMScriptMessageHandler called `Bridge`, the js register a object called `window.Bridge`.
STMScriptMessageHandler *messageHandler = [[STMScriptMessageHandler alloc] initWithScriptMessageHandlerName:@"Bridge" forWebView:self.webView];
[self.webView stm_addScriptMessageHandler:messageHandler];
// register a message handler named `Page`, so the js should call your method (that the message handler registered) use `window.Page.callMethod...`
STMScriptMessageHandler *page = [[STMScriptMessageHandler alloc] initWithScriptMessageHandlerName:@"Page" forWebView:self.webView];
[self.webView registerScriptMessageHandler:page];
[page registerMethod:@"setButtons" handler:^(id data, STMResponseCallback responseCallback) {
[self setupRightBarButtonItems:data callback:responseCallback];
}];
```
#### JS side
```javascript
// Use js object `window.Bridge` call native method or register method for native.
window.Bridge.callHandler('nslog', data, function (data) {
log('JS got native `nslog` response', data);
});
window.Bridge.registerMethod('log', function(data, callback){
var message = JSON.parse(data);
log('Native calling js method `log`', message);
callback({key: 'from js', value: 'something'});
});
// Support Promise
async function promise(data) {
// window.Bridge.callHandler('nslog', data).then(
// result => log('JS got native `nslog` response', result),
// error => log('JS got native `nslog` error', error)
// )
var p = window.Bridge.callHandler('nslog', data);
var result = await p;
log('JS got native `nslog` response', result);
}
```
#### Migrate from `WebViewJavascriptBridge`
If you register a message handler named `WebViewJavascriptBridge` at native side, the js side dones not need modify any code.
```objectivec
// The bridge's name is `WebViewJavascriptBridge`
self.bridge = [self.webView stm_addScriptMessageHandlerUseName:@"WebViewJavascriptBridge"];
```
## Installation
STMScriptMessageHandler is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'STMScriptMessageHandler'
```
## License
STMScriptMessageHandler is available under the MIT license and 996ICU license. See file `LICENSE.MIT` and `LICENSE.NPL` for more info.