electron-screenshots 0.5.22 → 0.5.24

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 nashaofu
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 nashaofu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,225 +1,231 @@
-# electron-screenshots
-
-> electron 截图插件
-
-## Prerequisites
-
-- electron >= 11
-
-## Install
-
-[![NPM](https://nodei.co/npm/electron-screenshots.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/electron-screenshots/)
-
-## Usage
-
-```ts
-import debug from "electron-debug";
-import { app, globalShortcut } from "electron";
-import Screenshots from "./screenshots";
-
-app.whenReady().then(() => {
-  const screenshots = new Screenshots();
-  globalShortcut.register("ctrl+shift+a", () => {
-    screenshots.startCapture();
-    screenshots.$view.webContents.openDevTools();
-  });
-  // 点击确定按钮回调事件
-  screenshots.on("ok", (e, buffer, bounds) => {
-    console.log("capture", buffer, bounds);
-  });
-  // 点击取消按钮回调事件
-  screenshots.on("cancel", () => {
-    console.log("capture", "cancel1");
-  });
-  screenshots.on("cancel", (e) => {
-    // 执行了preventDefault
-    // 点击取消不会关闭截图窗口
-    e.preventDefault();
-    console.log("capture", "cancel2");
-  });
-  // 点击保存按钮回调事件
-  screenshots.on("save", (e, buffer, bounds) => {
-    console.log("capture", buffer, bounds);
-  });
-  debug({ showDevTools: true, devToolsMode: "undocked" });
-});
-
-app.on("window-all-closed", () => {
-  if (process.platform !== "darwin") {
-    app.quit();
-  }
-});
-```
-
-### 注意
-
-- 如果使用了 webpack 打包主进程，请在主进程 webpack 配置中修改如下配置，否则可能会出现不能调用截图窗口的情况
-
-```js
-{
-  externals: {
-    'electron-screenshots': 'require("electron-screenshots")'
-  }
-}
-```
-
-- `vue-cli-plugin-electron-builder`配置示例[vue-cli-plugin-electron-builder-issue](https://github.com/nashaofu/vue-cli-plugin-electron-builder-issue/blob/0f774a90b09e10b02f86fcb6b50645058fe1a4e8/vue.config.js#L1-L8)
-
-```js
-// vue.config.js
-module.exports = {
-  publicPath: ".",
-  pluginOptions: {
-    electronBuilder: {
-      // 不打包，使用 require 加载
-      externals: ["electron-screenshots"],
-    },
-  },
-};
-```
-
-- 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](https://github.com/debug-js/debug)中的`Debugger`类型
-
-```ts
-export type LoggerFn = (...args: unknown[]) => void;
-export type Logger = Debugger | LoggerFn;
-
-export interface Lang {
-  magnifier_position_label?: string;
-  operation_ok_title?: string;
-  operation_cancel_title?: string;
-  operation_save_title?: string;
-  operation_redo_title?: string;
-  operation_undo_title?: string;
-  operation_mosaic_title?: string;
-  operation_text_title?: string;
-  operation_brush_title?: string;
-  operation_arrow_title?: string;
-  operation_ellipse_title?: string;
-  operation_rectangle_title?: string;
-}
-
-export interface ScreenshotsOpts {
-  lang?: Lang;
-  // 调用日志，默认值为 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): Promise<void>`              | 修改语言         | -      |
-
-## Events
-
-- 数据类型
-
-```ts
-interface Bounds {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-}
-
-export interface Display {
-  id: number;
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-}
-
-export interface ScreenshotsData {
-  bounds: Bounds;
-  display: Display;
-}
-
-class Event {
-  public defaultPrevented = false;
-
-  public preventDefault(): void {
-    this.defaultPrevented = true;
-  }
-}
-```
-
-| 名称          | 说明                                                        | 回调参数                                                        |
-| ------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
-| ok            | 截图确认事件                                                | `(event: Event, buffer: Buffer, data: ScreenshotsData) => void` |
-| cancel        | 截图取消事件                                                | `(event: Event) => void`                                        |
-| save          | 截图保存事件                                                | `(event: Event, buffer: Buffer, data: ScreenshotsData) => void` |
-| windowCreated | 截图窗口被创建后触发                                        | `($win: BrowserWindow) => void`                                 |
-| windowClosed  | 截图窗口被关闭后触发，对`BrowserWindow` `closed` 事件的转发 | `($win: BrowserWindow) => void`                                 |
-
-### 说明
-
-- event: 事件对象
-- buffer: png 图片 buffer
-- bounds: 截图区域信息
-- display: 截图的屏幕
-- `event`对象可调用`preventDefault`方法来阻止默认事件，例如阻止默认保存事件
-
-```ts
-const screenshots = new Screenshots({
-  lang: {
-    magnifier_position_label: "Position",
-    operation_ok_title: "Ok",
-    operation_cancel_title: "Cancel",
-    operation_save_title: "Save",
-    operation_redo_title: "Redo",
-    operation_undo_title: "Undo",
-    operation_mosaic_title: "Mosaic",
-    operation_text_title: "Text",
-    operation_brush_title: "Brush",
-    operation_arrow_title: "Arrow",
-    operation_ellipse_title: "Ellipse",
-    operation_rectangle_title: "Rectangle",
-  },
-});
-
-screenshots.on("save", (e, buffer, data) => {
-  // 阻止插件自带的保存功能
-  // 用户自己控制保存功能
-  e.preventDefault();
-  // 用户可在这里自己定义保存功能
-  console.log("capture", buffer, data);
-});
-
-screenshots.startCapture();
-```
-
-## Screenshot
-
-![screenshot](../../screenshot.jpg)
+# electron-screenshots
+
+> electron 截图插件
+
+## Prerequisites
+
+- electron >= 11
+
+## Install
+
+[![NPM](https://nodei.co/npm/electron-screenshots.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/electron-screenshots/)
+
+## Usage
+
+```ts
+import debug from "electron-debug";
+import { app, globalShortcut } from "electron";
+import Screenshots from "./screenshots";
+
+app.whenReady().then(() => {
+  const screenshots = new Screenshots();
+  globalShortcut.register("ctrl+shift+a", () => {
+    screenshots.startCapture();
+    screenshots.$view.webContents.openDevTools();
+  });
+  // 点击确定按钮回调事件
+  screenshots.on("ok", (e, buffer, bounds) => {
+    console.log("capture", buffer, bounds);
+  });
+  // 点击取消按钮回调事件
+  screenshots.on("cancel", () => {
+    console.log("capture", "cancel1");
+  });
+  screenshots.on("cancel", (e) => {
+    // 执行了preventDefault
+    // 点击取消不会关闭截图窗口
+    e.preventDefault();
+    console.log("capture", "cancel2");
+  });
+  // 点击保存按钮回调事件
+  screenshots.on("save", (e, buffer, bounds) => {
+    console.log("capture", buffer, bounds);
+  });
+  // 保存后的回调事件
+  screenshots.on("afterSave", (e, buffer, bounds, isSaved) => {
+    console.log("capture", buffer, bounds);
+    console.log("isSaved", isSaved) // 是否保存成功
+  });
+  debug({ showDevTools: true, devToolsMode: "undocked" });
+});
+
+app.on("window-all-closed", () => {
+  if (process.platform !== "darwin") {
+    app.quit();
+  }
+});
+```
+
+### 注意
+
+- 如果使用了 webpack 打包主进程，请在主进程 webpack 配置中修改如下配置，否则可能会出现不能调用截图窗口的情况
+
+```js
+{
+  externals: {
+    'electron-screenshots': 'require("electron-screenshots")'
+  }
+}
+```
+
+- `vue-cli-plugin-electron-builder`配置示例[vue-cli-plugin-electron-builder-issue](https://github.com/nashaofu/vue-cli-plugin-electron-builder-issue/blob/0f774a90b09e10b02f86fcb6b50645058fe1a4e8/vue.config.js#L1-L8)
+
+```js
+// vue.config.js
+module.exports = {
+  publicPath: ".",
+  pluginOptions: {
+    electronBuilder: {
+      // 不打包，使用 require 加载
+      externals: ["electron-screenshots"],
+    },
+  },
+};
+```
+
+- 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](https://github.com/debug-js/debug)中的`Debugger`类型
+
+```ts
+export type LoggerFn = (...args: unknown[]) => void;
+export type Logger = Debugger | LoggerFn;
+
+export interface Lang {
+  magnifier_position_label?: string;
+  operation_ok_title?: string;
+  operation_cancel_title?: string;
+  operation_save_title?: string;
+  operation_redo_title?: string;
+  operation_undo_title?: string;
+  operation_mosaic_title?: string;
+  operation_text_title?: string;
+  operation_brush_title?: string;
+  operation_arrow_title?: string;
+  operation_ellipse_title?: string;
+  operation_rectangle_title?: string;
+}
+
+export interface ScreenshotsOpts {
+  lang?: Lang;
+  // 调用日志，默认值为 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): Promise<void>`              | 修改语言         | -      |
+
+## Events
+
+- 数据类型
+
+```ts
+interface Bounds {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface Display {
+  id: number;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export interface ScreenshotsData {
+  bounds: Bounds;
+  display: Display;
+}
+
+class Event {
+  public defaultPrevented = false;
+
+  public preventDefault(): void {
+    this.defaultPrevented = true;
+  }
+}
+```
+
+| 名称          | 说明                                                        | 回调参数                                                                          |
+| ------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| ok            | 截图确认事件                                                | `(event: Event, buffer: Buffer, data: ScreenshotsData) => void`                   |
+| cancel        | 截图取消事件                                                | `(event: Event) => void`                                                          |
+| save          | 截图保存事件                                                | `(event: Event, buffer: Buffer, data: ScreenshotsData) => void`                   |
+| afterSave     | 截图保存（取消保存）后的事件                                | `(event: Event, buffer: Buffer, data: ScreenshotsData, isSaved: boolean) => void` |
+| windowCreated | 截图窗口被创建后触发                                        | `($win: BrowserWindow) => void`                                                   |
+| windowClosed  | 截图窗口被关闭后触发，对`BrowserWindow` `closed` 事件的转发 | `($win: BrowserWindow) => void`                                                   |
+
+### 说明
+
+- event: 事件对象
+- buffer: png 图片 buffer
+- bounds: 截图区域信息
+- display: 截图的屏幕
+- `event`对象可调用`preventDefault`方法来阻止默认事件，例如阻止默认保存事件
+
+```ts
+const screenshots = new Screenshots({
+  lang: {
+    magnifier_position_label: "Position",
+    operation_ok_title: "Ok",
+    operation_cancel_title: "Cancel",
+    operation_save_title: "Save",
+    operation_redo_title: "Redo",
+    operation_undo_title: "Undo",
+    operation_mosaic_title: "Mosaic",
+    operation_text_title: "Text",
+    operation_brush_title: "Brush",
+    operation_arrow_title: "Arrow",
+    operation_ellipse_title: "Ellipse",
+    operation_rectangle_title: "Rectangle",
+  },
+});
+
+screenshots.on("save", (e, buffer, data) => {
+  // 阻止插件自带的保存功能
+  // 用户自己控制保存功能
+  e.preventDefault();
+  // 用户可在这里自己定义保存功能
+  console.log("capture", buffer, data);
+});
+
+screenshots.startCapture();
+```
+
+## Screenshot
+
+![screenshot](../../screenshot.jpg)

package/lib/demo.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/demo.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+var electron_1 = require("electron");
+var _1 = __importDefault(require("."));
+electron_1.app.whenReady().then(function () {
+    var screenshots = new _1.default({
+        lang: {
+            operation_rectangle_title: '矩形2323',
+        },
+        singleWindow: true,
+    });
+    screenshots.$view.webContents.openDevTools();
+    electron_1.globalShortcut.register('ctrl+shift+a', function () {
+        screenshots.startCapture();
+    });
+    screenshots.on('windowCreated', function ($win) {
+        $win.on('focus', function () {
+            electron_1.globalShortcut.register('esc', function () {
+                if ($win === null || $win === void 0 ? void 0 : $win.isFocused()) {
+                    screenshots.endCapture();
+                }
+            });
+        });
+        $win.on('blur', function () {
+            electron_1.globalShortcut.unregister('esc');
+        });
+    });
+    // 防止不能关闭截图界面
+    electron_1.globalShortcut.register('ctrl+shift+q', function () {
+        electron_1.app.quit();
+    });
+    // 点击确定按钮回调事件
+    screenshots.on('ok', function (e, buffer, bounds) {
+        console.log('capture', buffer, bounds);
+    });
+    // 点击取消按钮回调事件
+    screenshots.on('cancel', function () {
+        console.log('capture', 'cancel1');
+        screenshots.setLang({
+            operation_ellipse_title: 'ellipse',
+            operation_rectangle_title: 'rectangle',
+        });
+    });
+    // 点击保存按钮回调事件
+    screenshots.on('save', function (e, buffer, bounds) {
+        console.log('capture', buffer, bounds);
+    });
+    var mainWin = new electron_1.BrowserWindow({
+        show: true,
+    });
+    mainWin.removeMenu();
+    mainWin.loadURL('https://github.com/nashaofu');
+});
+electron_1.app.on('window-all-closed', function () {
+    if (process.platform !== 'darwin') {
+        electron_1.app.quit();
+    }
+});

package/lib/index.cjs.js

@@ -0,0 +1,2 @@
+"use strict";
+module.exports = require('.').default;

package/lib/index.d.ts

@@ -1 +1,57 @@
-export {};
+/// <reference types="node" />
+import { Debugger } from 'debug';
+import { BrowserView, BrowserWindow } from 'electron';
+import Events from 'events';
+import { Bounds } from './preload';
+export type LoggerFn = (...args: unknown[]) => void;
+export type Logger = Debugger | LoggerFn;
+export interface Lang {
+    magnifier_position_label?: string;
+    operation_ok_title?: string;
+    operation_cancel_title?: string;
+    operation_save_title?: string;
+    operation_redo_title?: string;
+    operation_undo_title?: string;
+    operation_mosaic_title?: string;
+    operation_text_title?: string;
+    operation_brush_title?: string;
+    operation_arrow_title?: string;
+    operation_ellipse_title?: string;
+    operation_rectangle_title?: string;
+}
+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);
+    /**
+     * 开始截图
+     */
+    startCapture(): Promise<void>;
+    /**
+     * 结束截图
+     */
+    endCapture(): Promise<void>;
+    /**
+     * 设置语言
+     */
+    setLang(lang: Partial<Lang>): Promise<void>;
+    private reset;
+    /**
+     * 初始化窗口
+     */
+    private createWindow;
+    private capture;
+    /**
+     * 绑定ipc时间处理
+     */
+    private listenIpc;
+}