Skip to content

Commit fb6bd34

Browse files
docs: clarify InAppBrowser docs (#441)
1 parent c3a58af commit fb6bd34

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/apis/inappbrowser.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Closes the currently active browser. It can be used to close browsers launched t
168168
addListener(eventName: 'browserClosed' | 'browserPageLoaded', listenerFunc: () => void) => Promise<PluginListenerHandle>
169169
```
170170

171-
Adds a listener for the specified browser event.
171+
Adds a listener for the specified browser events, with no data being returned.
172172

173173
| Param | Type | Description |
174174
| ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------ |
@@ -186,12 +186,12 @@ Adds a listener for the specified browser event.
186186
addListener(eventName: 'browserPageNavigationCompleted', listenerFunc: (data: BrowserPageNavigationCompletedEventData) => void) => Promise<PluginListenerHandle>
187187
```
188188

189-
Adds a listener for the specified browser event.
189+
Adds a listener for the specified browser event, which receives data.
190190

191-
| Param | Type | Description |
192-
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
193-
| **`eventName`** | <code>'browserPageNavigationCompleted'</code> | The name of the browser event to listen for: 'browserPageNavigationCompleted'. |
194-
| **`listenerFunc`** | <code>(data: <a href="#browserpagenavigationcompletedeventdata">BrowserPageNavigationCompletedEventData</a>) =&gt; void</code> | The function to be called when the event occurs. |
191+
| Param | Type | Description |
192+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
193+
| **`eventName`** | <code>'browserPageNavigationCompleted'</code> | The name of the browser event to listen for: 'browserPageNavigationCompleted'. Applies only to openInWebView. |
194+
| **`listenerFunc`** | <code>(data: <a href="#browserpagenavigationcompletedeventdata">BrowserPageNavigationCompletedEventData</a>) =&gt; void</code> | The function to be called when the event occurs. |
195195

196196
**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
197197

@@ -293,10 +293,10 @@ Defines the options for opening a URL in the system browser.
293293

294294
#### AndroidBottomSheet
295295

296-
| Prop | Type | Description |
297-
| ------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
298-
| **`height`** | <code>number</code> | Sets the height of the bottom sheet. This will be a minimum of 50% of the screen's height. If no value is passed, we will default to the minimum value. |
299-
| **`isFixed`** | <code>boolean</code> | Sets whether the bottom sheet is fixed. |
296+
| Prop | Type | Description |
297+
| ------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
298+
| **`height`** | <code>number</code> | Sets the height of the bottom sheet, in pixels. Custom tabs will set the bottom height to at least 50% of the screen. If no value is passed, it will default to the minimum value. |
299+
| **`isFixed`** | <code>boolean</code> | Sets whether the bottom sheet is fixed. |
300300

301301

302302
#### iOSSystemBrowserOptions

0 commit comments

Comments
 (0)