electron-screenshots 0.4.5 → 0.5.2

package/README.md

@@ -78,6 +78,27 @@ module.exports = {
 }
 ```
 
+- esc 取消截图，可用以下代码实现按 esc 取消截图
+
+```js
+globalShortcut.register('esc', () => {
+  if (screenshots.$win?.isFocused()) {
+    screenshots.endCapture()
+  }
+})
+```
+
+- 加速截图界面展示，不销毁`BrowserWindow`，减少创建窗口的开销，可用以下代码实现。**需注意，启用该功能，会导致`window-all-closed`事件不触发，因此需要手动关闭截图窗口**
+
+```js
+// 是否复用截图窗口，加快截图窗口显示，默认值为 false
+// 如果设置为 true 则会在第一次调用截图窗口时创建，后续调用时直接使用
+// 且由于窗口不会 close，所以不会触发 app 的 `window-all-closed` 事件
+const screenshots = new Screenshots({
+  singleWindow: true
+})
+```
+
 ## Methods
 
 - `Debugger`类型产考`debug`中的`Debugger`类型
@@ -106,15 +127,19 @@ export interface ScreenshotsOpts {
   // 调用日志，默认值为 debug('electron-screenshots')
   // debug https://www.npmjs.com/package/debug
   logger?: Logger
+  // 是否复用截图窗口，加快截图窗口显示，默认值为 false
+  // 如果设置为 true 则会在第一次调用截图窗口时创建，后续调用时直接使用
+  // 且由于窗口不会 close，所以不会触发 app 的 `window-all-closed` 事件
+  singleWindow?: boolean
 }
 ```
 
-| 名称                                 | 说明             | 返回值 |
-| ------------------------------------ | ---------------- | ------ |
+| 名称                                              | 说明             | 返回值 |
+| ------------------------------------------------- | ---------------- | ------ |
 | `constructor(opts: ScreenshotsOpts): Screenshots` | 调用截图方法截图 | -      |
-| `startCapture(): Promise<void>`                     | 调用截图方法截图 | -      |
-| `endCapture(): Promise<void>`                      | 手动结束截图     | -      |
-| `setLang(lang: Lang): void`                | 修改语言         | -      |
+| `startCapture(): Promise<void>`                   | 调用截图方法截图 | -      |
+| `endCapture(): Promise<void>`                     | 手动结束截图     | -      |
+| `setLang(lang: Lang): Promise<void>`              | 修改语言         | -      |
 
 ## Events
 

package/lib/index.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var electron_1 = require("electron");
-var electron_debug_1 = __importDefault(require("electron-debug"));
 var screenshots_1 = __importDefault(require("./screenshots"));
 electron_1.app.whenReady().then(function () {
     var screenshots = new screenshots_1.default({
@@ -17,11 +16,16 @@ electron_1.app.whenReady().then(function () {
                 args[_i] = arguments[_i];
             }
             return console.log(args);
-        }
+        },
+        singleWindow: true
     });
+    screenshots.$view.webContents.openDevTools();
     electron_1.globalShortcut.register('ctrl+shift+a', function () {
         screenshots.startCapture();
-        screenshots.$view.webContents.openDevTools();
+    });
+    // 防止不能关闭截图界面
+    electron_1.globalShortcut.register('ctrl+shift+q', function () {
+        electron_1.app.quit();
     });
     // 点击确定按钮回调事件
     screenshots.on('ok', function (e, buffer, bounds) {
@@ -39,7 +43,6 @@ electron_1.app.whenReady().then(function () {
     screenshots.on('save', function (e, buffer, bounds) {
         console.log('capture', buffer, bounds);
     });
-    (0, electron_debug_1.default)({ showDevTools: true, devToolsMode: 'undocked' });
 });
 electron_1.app.on('window-all-closed', function () {
     if (process.platform !== 'darwin') {

package/lib/screenshots.d.ts

@@ -22,12 +22,14 @@ export interface Lang {
 export interface ScreenshotsOpts {
     lang?: Lang;
     logger?: Logger;
+    singleWindow?: boolean;
 }
 export { Bounds };
 export default class Screenshots extends Events {
     $win: BrowserWindow | null;
     $view: BrowserView;
     private logger;
+    private singleWindow;
     private isReady;
     constructor(opts?: ScreenshotsOpts);
     /**
@@ -41,7 +43,7 @@ export default class Screenshots extends Events {
     /**
      * 设置语言
      */
-    setLang(lang: Partial<Lang>): void;
+    setLang(lang: Partial<Lang>): Promise<void>;
     private reset;
     /**
      * 初始化窗口

package/lib/screenshots.js

@@ -101,6 +101,7 @@ var Screenshots = /** @class */ (function (_super) {
             });
         });
         _this.logger = (opts === null || opts === void 0 ? void 0 : opts.logger) || (0, debug_1.default)('electron-screenshots');
+        _this.singleWindow = (opts === null || opts === void 0 ? void 0 : opts.singleWindow) || false;
         _this.listenIpc();
         _this.$view.webContents.loadURL("file://".concat(require.resolve('react-screenshots/electron/electron.html')));
         if (opts === null || opts === void 0 ? void 0 : opts.lang) {
@@ -129,6 +130,7 @@ var Screenshots = /** @class */ (function (_super) {
                         if (!this.$win) {
                             return [2 /*return*/];
                         }
+                        this.$win.blur();
                         this.$win.show();
                         return [2 /*return*/];
                 }
@@ -150,11 +152,22 @@ var Screenshots = /** @class */ (function (_super) {
                         if (!this.$win) {
                             return [2 /*return*/];
                         }
-                        this.$win.setBrowserView(null);
-                        this.$win.setSimpleFullScreen(false);
+                        // 先清除 Kiosk 模式，然后取消全屏才有效
                         this.$win.setKiosk(false);
-                        this.$win.close();
-                        this.$win = null;
+                        this.$win.setFullScreen(false);
+                        this.$win.setSimpleFullScreen(false);
+                        this.$win.blur();
+                        this.$win.setBrowserView(null);
+                        // 必须设置为 closable 为 true
+                        // 否者不能关闭窗口
+                        this.$win.setClosable(true);
+                        if (this.singleWindow) {
+                            this.$win.hide();
+                        }
+                        else {
+                            this.$win.close();
+                            this.$win = null;
+                        }
                         return [2 /*return*/];
                 }
             });
@@ -164,10 +177,18 @@ var Screenshots = /** @class */ (function (_super) {
      * 设置语言
      */
     Screenshots.prototype.setLang = function (lang) {
-        var _this = this;
-        this.isReady.then(function () {
-            _this.logger('setLang', lang);
-            _this.$view.webContents.send('SCREENSHOTS:setLang', lang);
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.logger('setLang', lang);
+                        return [4 /*yield*/, this.isReady];
+                    case 1:
+                        _a.sent();
+                        this.$view.webContents.send('SCREENSHOTS:setLang', lang);
+                        return [2 /*return*/];
+                }
+            });
         });
     };
     Screenshots.prototype.reset = function () {
@@ -222,6 +243,9 @@ var Screenshots = /** @class */ (function (_super) {
                                 transparent: true,
                                 resizable: false,
                                 movable: false,
+                                closable: false,
+                                minimizable: false,
+                                maximizable: false,
                                 // focusable: true, 否则窗口不能及时响应esc按键，输入框也不能输入
                                 focusable: true,
                                 // linux 下必须设置为false，否则不能全屏显示在最上层
@@ -235,20 +259,22 @@ var Screenshots = /** @class */ (function (_super) {
                                 enableLargerThanScreen: true,
                                 skipTaskbar: true,
                                 hasShadow: false,
-                                minimizable: false,
-                                maximizable: false,
-                                paintWhenInitiallyHidden: false
+                                paintWhenInitiallyHidden: false,
+                                acceptFirstMouse: true
                             });
                             this.$win.on('show', function () {
                                 var _a, _b;
+                                (_a = _this.$win) === null || _a === void 0 ? void 0 : _a.focus();
                                 // 在窗口显示时设置，防止与 fullscreen、x、y、width、height 等冲突
                                 // 导致显示效果不符合预期
-                                (_a = _this.$win) === null || _a === void 0 ? void 0 : _a.setKiosk(true);
-                                (_b = _this.$win) === null || _b === void 0 ? void 0 : _b.focus();
+                                (_b = _this.$win) === null || _b === void 0 ? void 0 : _b.setKiosk(true);
                             });
                         }
-                        this.$win.setBounds(display);
+                        this.$win.setFullScreen(process.platform === 'darwin');
+                        // 设置为 false，mac 就不显示左上角关闭按钮
+                        this.$win.setClosable(false);
                         this.$win.setBrowserView(this.$view);
+                        this.$win.setBounds(display);
                         this.$view.setBounds({
                             x: 0,
                             y: 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-screenshots",
-  "version": "0.4.5",
+  "version": "0.5.2",
   "description": "electron 截图插件",
   "types": "lib/screenshots.d.ts",
   "main": "lib/screenshots.js",
@@ -38,7 +38,7 @@
     "debug": "^4.3.3",
     "fs-extra": "^10.1.0",
     "node-screenshots": "^0.0.3",
-    "react-screenshots": "^0.4.5"
+    "react-screenshots": "^0.5.1"
   },
   "peerDependencies": {
     "electron": ">=11"
@@ -50,7 +50,6 @@
     "@typescript-eslint/parser": "^5.10.0",
     "cross-env": "^7.0.3",
     "electron": "^16.0.7",
-    "electron-debug": "^3.2.0",
     "eslint": "^8.7.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.25.4",
@@ -59,5 +58,5 @@
     "rimraf": "^3.0.2",
     "typescript": "^4.5.5"
   },
-  "gitHead": "83c063ecd6b84c75cea303543e01949b352d148c"
+  "gitHead": "8cfc003a0b5159255cea5e2990515fc824982b1e"
 }