Skip to content
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

docs(browser): Add clarifications to browser events #560

Merged
merged 1 commit into from
Aug 23, 2021
Merged

docs(browser): Add clarifications to browser events #560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion browser/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ No-op on other platforms.
addListener(eventName: 'browserFinished', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle
```

Android & iOS only: Listen for the loading finished event.
Android & iOS only: Listen for the browser finished event.
It fires when the Browser is closed by the user.

| Param | Type |
| ------------------ | ------------------------------ |
Expand All @@ -104,6 +105,8 @@ addListener(eventName: 'browserPageLoaded', listenerFunc: () => void) => Promise
```

Android & iOS only: Listen for the page loaded event.
It's only fired when the URL passed to open method finish loading.
It is not invoked for any subsequent page loads.

| Param | Type |
| ------------------ | -------------------------------- |
Expand Down
5 changes: 4 additions & 1 deletion browser/src/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ export interface BrowserPlugin {
close(): Promise<void>;

/**
* Android & iOS only: Listen for the loading finished event.
* Android & iOS only: Listen for the browser finished event.
* It fires when the Browser is closed by the user.
*
* @since 1.0.0
*/
Expand All @@ -29,6 +30,8 @@ export interface BrowserPlugin {

/**
* Android & iOS only: Listen for the page loaded event.
* It's only fired when the URL passed to open method finish loading.
* It is not invoked for any subsequent page loads.
*
* @since 1.0.0
*/
Expand Down