@el3um4s/electron-window - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

lib/IPC/BrowserView.js

@@ -17,4 +17,4 @@ "use strict";
 const validSendChannel = {
+    showBrowserView: showBrowserView,
     openInBrowserView: openInBrowserView,
-    showBrowserView: showBrowserView,
     removeBrowserView: removeBrowserView,
@@ -66,3 +66,3 @@ openBrowserViewDevTools: openBrowserViewDevTools,
         if (bw) {
-            bw.webContents.loadURL(message.src);
+            bw.webContents.loadURL(message.url);
         }
@@ -76,6 +76,4 @@ });
         if (show) {
-            const present = bw ? "yes" : "no";
-            customWindow.webContents.send("showBrowserView", {
-                present,
-            });
+            const canShow = bw ? true : false;
+            customWindow.webContents.send("showBrowserView", canShow);
         }
@@ -82,0 +80,0 @@ setBounds(customWindow, message, true);

package.json

 {
   "name": "@el3um4s/electron-window",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Electron - create a window with optional autoupdater and browserview",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -61,4 +61,45 @@ # Electron Window (NOT YET TESTED)
 
-### API
+To use in the renderer install:
 
+```bash
+npm i @el3um4s/electron-window @el3um4s/renderer-electron-window-browser-view  @el3um4s/ipc-for-electron
+```
+
+Then in the preload file:
+
+```ts
+import { generateContextBridge } from "@el3um4s/ipc-for-electron";
+import { browserView } from "@el3um4s/electron-window";
+
+const listAPI = [browserView];
+
+generateContextBridge(listAPI, "ipc");
+```
+
+Then in the renderer:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.openInBrowserView({ url: "https://www.google.com", apiKey: "ipc" });
+
+browserView.showBrowserView({
+  bounds: {
+    paddingLeft: 64,
+    paddingTop: 64,
+    paddingRight: 128,
+    paddingBottom: 128,
+  },
+  apiKey: "ipc",
+});
+
+chokidar.on.browserViewCanBeShowed({
+  callback: (data) => {
+    console.log(data);
+  },
+});
+```
+
+### API: main process
+
 `new ElectronWindow(settings?: Electron.BrowserWindowConstructorOptions):ElectronWindow`: create a new instance of ElectronWindow
@@ -215,2 +256,172 @@
 
+### API: browserView - Electron Side
+
+- `openInBrowserView`: open the url in the browserView.
+- `showBrowserView`: show the browserView. The response is sent to the `showBrowserView` channel.
+- `resizeBrowserViewToMaximized`: resize the browserView to the maximized size.
+- `resizeBrowserViewToUnMaximized`: resize the window to the un-maximized size.
+- `removeBrowserView`: remove the browserView.
+- `openBrowserViewDevTools`: open the devTools of the browserView.
+- `printBrowserView`: print the browserView.
+- `goBackBrowserView`: go back in the browserView.
+- `goForwardBrowserView`: go forward in the browserView.
+- `reloadCurrentPageBrowserView`: reload the current page in the browserView.
+
+### API: browserView - Renderer Side
+
+`on.browserViewCanBeShowed = async (options: { callback?: (arg0: boolean) => void; apiKey?: string; }): Promise<boolean>`
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.openInBrowserView({ url: "https://www.google.com", apiKey: "ipc" });
+
+browserView.showBrowserView({
+  bounds: {
+    paddingLeft: 64,
+    paddingTop: 64,
+    paddingRight: 128,
+    paddingBottom: 128,
+  },
+  apiKey: "ipc",
+});
+
+chokidar.on.browserViewCanBeShowed({
+  callback: (data) => {
+    console.log(data);
+  },
+});
+```
+
+`showBrowserView = async (options: { callback?: (arg0: boolean) => void; apiKey?: string; bounds?: BrowserViewBounds; }): Promise<boolean>`: show the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.openInBrowserView({ url: "https://www.google.com", apiKey: "ipc" });
+
+browserView.showBrowserView({
+  bounds: {
+    paddingLeft: 64,
+    paddingTop: 64,
+    paddingRight: 128,
+    paddingBottom: 128,
+  },
+  apiKey: "ipc",
+  callback: (data) => {
+    console.log(
+      data ? "BrowserView can be shown" : "BrowserView can't be shown"
+    );
+  },
+});
+```
+
+`openInBrowserView = (options: { apiKey?: string; url: string }): void`: open the url in the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.openInBrowserView({ url: "https://www.google.com", apiKey: "ipc" });
+```
+
+`resizeBrowserViewToMaximized = (options?: { apiKey?: string; bounds?: BrowserViewBounds; }): void`: resize the browserView to the maximized size
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+const bounds: {
+  paddingLeft: 64;
+  paddingTop: 64;
+  paddingRight: 64;
+  paddingBottom: 64;
+};
+
+browserView.resizeBrowserViewToMaximized({ bounds, apiKey: "ipc" });
+```
+
+`resizeBrowserViewToUnMaximized = (options?: { apiKey?: string; bounds?: BrowserViewBounds; }): void`: resize the browserView to the un-maximized size
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+const bounds: {
+  paddingLeft: 64;
+  paddingTop: 64;
+  paddingRight: 64;
+  paddingBottom: 64;
+};
+
+browserView.resizeBrowserViewToUnMaximized({ bounds });
+```
+
+`removeBrowserView = (options?: { apiKey?: string }): void`: remove the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.removeBrowserView({ apiKey: "ipc" });
+```
+
+`openBrowserViewDevTools = (options?: { apiKey?: string }): void`: open the dev tools window of the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.openBrowserViewDevTools();
+```
+
+`printBrowserView = (options?: { apiKey?: string }): void`: print the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.printBrowserView();
+```
+
+`goBackBrowserView = (options?: { apiKey?: string }): void`: go back in the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.goBackBrowserView();
+```
+
+`goForwardBrowserView = (options?: { apiKey?: string }): void`: go forward in the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.goForwardBrowserView();
+```
+
+`reloadCurrentPageBrowserView = (options?: { apiKey?: string }): void`: reload the current page in the browserView
+
+example:
+
+```ts
+import browserView from "@el3um4s/renderer-electron-window-browser-view";
+
+browserView.reloadCurrentPageBrowserView();
+```
+
 ### Default settings
@@ -217,0 +428,0 @@

No alert changes

Improved metrics

Total package byte prevSize

34074

increased by49.29%

Number of package files

13

increased by18.18%

Lines of code

472

increased by41.32%

Number of lines in readme file

471

increased by81.15%

No dependency changes