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

ionic-team · Aug 23, 2021 · f398162 · f398162
1 parent 31cfdb4
commit f398162
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/browser/README.md b/browser/README.md
@@ -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                           |
 | ------------------ | ------------------------------ |
@@ -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                             |
 | ------------------ | -------------------------------- |

diff --git a/browser/src/definitions.ts b/browser/src/definitions.ts
@@ -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
    */
@@ -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
    */