Skip to content

Commit ff6497c

Browse files
committed
Improve documentation header levels
1 parent c2eddcb commit ff6497c

File tree

1 file changed

+15
-45
lines changed

1 file changed

+15
-45
lines changed

README.md

Lines changed: 15 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -50,49 +50,19 @@ In the dialog that appears:
5050
WebViewJavascriptBridge.send('Hello from the javascript')
5151
}, false)
5252

53-
5) Optional API: Registered handlers
54-
55-
This lets you register named handlers for e.g. command handling. You should register handlers
56-
57-
*Note:* You need to 1) register ObjC handlers before loading the UIWebView, and 2) register javascript handlers before calling `WebViewJavascriptBridge.init`.
58-
59-
In ObjC:
60-
61-
// Register handler
62-
[javascriptBridge registerHandler:@"greetPerson" handler:^(id responseData, WVJBResponseHandler callback) {
63-
callback([NSString stringWithFormat:@"Hello, %@", [data objectForKey:@"name"]]);
64-
}];
65-
// Call javascript handlers
66-
[javascriptBridge callHandler:@"showAlert" data:@"FooBar"];
67-
[javascriptBridge callHandler:@"getUrl" data:nil callback:^(id data) {
68-
NSLog(@"UIWebView url is %@", data);
69-
}];
70-
71-
In javascript:
72-
73-
// Register handlers
74-
WebViewJavascriptBridge.registerHandler('showAlert', function(data) {
75-
alert(data)
76-
})
77-
WebViewJavascriptBridge.registerHandler('getUrl', function(data, responseCallback) {
78-
responseCallback(document.location.toString())
79-
})
80-
// Call ObjC handler
81-
WebViewJavascriptBridge.callHandler('greetPerson', { name:'Marcus' }, function responseCallback(data) {
82-
alert("ObjC created greeting: "+ data)
83-
})
84-
8553
iOS4 support (with JSONKit)
8654
---------------------------
8755

88-
WebViewJavascriptBridge uses `NSJSONSerialization` by default. If you need iOS 4 support then you can use [JSONKit](https://github.com/johnezang/JSONKit/), and add `USE_JSONKIT` to the preprocessor macros for your project.
56+
*Note*: iOS4 support has not yet been tested in v2.
57+
58+
WebViewJavascriptBridge uses `NSJSONSerialization` by default. If you need iOS 4 support then you can use [JSONKit](https://github.com/johnezang/JSONKit/), and add `USE_JSONKIT` to the preprocessor macros for your project.
8959

9060
API Reference
9161
-------------
9262

9363
### ObjC
9464

95-
#### `WebViewJavascriptBridge* bridge = [WebViewJavascriptBridge javascriptBridgeForWebView:(UIWebView*)webview handler:(WVJBHandler)handler]`
65+
##### `[WebViewJavascriptBridge javascriptBridgeForWebView:(UIWebView*)webview handler:(WVJBHandler)handler]`
9666

9767
Create a javascript bridge for the given UIWebView.
9868

@@ -107,8 +77,8 @@ Example:
10777

10878
The handler's `responseCallback` will be a block if javascript sent the message with a function responseCallback, or `nil` otherwise.
10979

110-
#### `[bridge send:(id)data]`
111-
#### `[bridge send:(id)data responseCallback:(WVJBResponseCallback)responseCallback]`
80+
##### `[bridge send:(id)data]`
81+
##### `[bridge send:(id)data responseCallback:(WVJBResponseCallback)responseCallback]`
11282

11383
Send a message to javascript. Optionally expect a response by giving a `responseCallback` block.
11484

@@ -120,7 +90,7 @@ Example:
12090
NSLog(@"Got response: %@", data);
12191
}];
12292

123-
#### `[bridge registerHandler:(NSString*)handlerName handler:(WVJBHandler)handler]`
93+
##### `[bridge registerHandler:(NSString*)handlerName handler:(WVJBHandler)handler]`
12494

12595
Register a handler called `handlerName`. The javascript can then call this handler with `WebViewJavascriptBridge.callHandler("handlerName", function(response) { ... })`.
12696

@@ -130,8 +100,8 @@ Example:
130100
responseCallback([NSNumber numberWithInt:[UIScreen mainScreen].bounds.size.height]);
131101
}];
132102

133-
#### `[bridge callHandler:(NSString*)handlerName data:(id)data]`
134-
#### `[bridge callHandler:(NSString*)handlerName data:(id)data responseCallback:(WVJBResponseCallback)responseCallback]`
103+
##### `[bridge callHandler:(NSString*)handlerName data:(id)data]`
104+
##### `[bridge callHandler:(NSString*)handlerName data:(id)data responseCallback:(WVJBResponseCallback)callback]`
135105

136106
Call the javascript handler called `handlerName`. Optionally expect a response by giving a `responseCallback` block.
137107

@@ -145,7 +115,7 @@ Example:
145115

146116
### Javascript
147117

148-
#### `document.addEventListener('WebViewJavascriptBridgeReady', function onBridgeReadyHandler() { ... }, false)`
118+
##### `document.addEventListener('WebViewJavascriptBridgeReady', function onBridgeReadyHandler() { ... }, false)`
149119

150120
Always wait for the `WebViewJavascriptBridgeReady` DOM event before using `WebViewJavascriptBridge`.
151121

@@ -155,7 +125,7 @@ Example:
155125
// Start using WebViewJavascriptBridge
156126
}, false)
157127

158-
#### `WebViewJavascriptBridge.init(function messageHandler(data, responseCallback) { ... })`
128+
##### `WebViewJavascriptBridge.init(function messageHandler(data, responseCallback) { ... })`
159129

160130
Initialize the WebViewJavascriptBridge. This should be called inside of the `'WebViewJavascriptBridgeReady'` event handler.
161131

@@ -172,9 +142,9 @@ Example:
172142
}
173143
})
174144

175-
#### `WebViewJavascriptBridge.send("Hi there!")`
176-
#### `WebViewJavascriptBridge.send({ Foo:"Bar" })`
177-
#### `WebViewJavascriptBridge.send(data, function responseCallback(responseData) { ... })`
145+
##### `WebViewJavascriptBridge.send("Hi there!")`
146+
##### `WebViewJavascriptBridge.send({ Foo:"Bar" })`
147+
##### `WebViewJavascriptBridge.send(data, function responseCallback(responseData) { ... })`
178148

179149
Send a message to ObjC. Optionally expect a response by giving a `responseCallback` function.
180150

@@ -185,7 +155,7 @@ Example:
185155
alert("I got a response! "+JSON.stringify(response))
186156
})
187157

188-
#### `WebViewJavascriptBridge.registerHandler("handlerName", function(data, responseCallback) { ... })`
158+
##### `WebViewJavascriptBridge.registerHandler("handlerName", function(data, responseCallback) { ... })`
189159

190160
Register a handler called `handlerName`. The ObjC can then call this handler with `[bridge callHandler:"handlerName" data:@"Foo"]` and `[bridge callHandler:"handlerName" data:@"Foo" responseCallback:^(id responseData) { ... }]`
191161

0 commit comments

Comments
 (0)