Skip to content

docs: browserPageNavigationCompleted only for openInWebView #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OS-pedrogustavobilro merged 2 commits into from
Aug 11, 2025
Merged

docs: browserPageNavigationCompleted only for openInWebView #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3d9de8
docs: browserPageNavigationCompleted only for openInWebView
OS-pedrogustavobilro Jul 11, 2025
d7d252f
Merge branch 'main' into docs/navigationCompleted
OS-pedrogustavobilro Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Closes the currently active browser. It can be used to close browsers launched t
addListener(eventName: 'browserClosed' | 'browserPageLoaded', listenerFunc: () => void) => Promise<PluginListenerHandle>
```

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

| Param | Type | Description |
| ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------ |
Expand All @@ -178,12 +178,12 @@ Adds a listener for the specified browser event.
addListener(eventName: 'browserPageNavigationCompleted', listenerFunc: (data: BrowserPageNavigationCompletedEventData) => void) => Promise<PluginListenerHandle>
```

Adds a listener for the specified browser event.
Adds a listener for the specified browser event, which receives data.

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

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

Expand Down
6 changes: 3 additions & 3 deletions src/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ export interface InAppBrowserPlugin {
close(): Promise<void>;

/**
* Adds a listener for the specified browser event.
* Adds a listener for the specified browser events, with no data being returned.
* @param eventName The name of the browser event to listen for: 'browserClosed' or 'browserPageLoaded'.
* @param listenerFunc The function to be called when the event occurs.
*/
Expand All @@ -212,8 +212,8 @@ export interface InAppBrowserPlugin {
): Promise<PluginListenerHandle>;

/**
* Adds a listener for the specified browser event.
* @param eventName The name of the browser event to listen for: 'browserPageNavigationCompleted'.
* Adds a listener for the specified browser event, which receives data.
* @param eventName The name of the browser event to listen for: 'browserPageNavigationCompleted'. Applies only to openInWebView.
* @param listenerFunc The function to be called when the event occurs.
*/
addListener(
Expand Down