electron-screenshots 0.5.14 → 0.5.16

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,223 +1,223 @@
-# 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`中的`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` |
-
-### 说明
-
-- 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)
+  })
+  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`中的`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` |
+
+### 说明
+
+- 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/event.d.ts

@@ -1,4 +1,4 @@
-export default class Event {
-    defaultPrevented: boolean;
-    preventDefault(): void;
-}
+export default class Event {
+    defaultPrevented: boolean;
+    preventDefault(): void;
+}

package/lib/event.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var Event = /** @class */ (function () {
-    function Event() {
-        this.defaultPrevented = false;
-    }
-    Event.prototype.preventDefault = function () {
-        this.defaultPrevented = true;
-    };
-    return Event;
-}());
-exports.default = Event;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Event = /** @class */ (function () {
+    function Event() {
+        this.defaultPrevented = false;
+    }
+    Event.prototype.preventDefault = function () {
+        this.defaultPrevented = true;
+    };
+    return Event;
+}());
+exports.default = Event;

package/lib/getDisplay.d.ts

@@ -1,6 +1,6 @@
-import { Rectangle } from 'electron';
-export interface Display extends Rectangle {
-    id: number;
-}
-declare const _default: () => Display;
-export default _default;
+import { Rectangle } from 'electron';
+export interface Display extends Rectangle {
+    id: number;
+}
+declare const _default: () => Display;
+export default _default;

package/lib/getDisplay.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var electron_1 = require("electron");
-exports.default = (function () {
-    var point = electron_1.screen.getCursorScreenPoint();
-    var _a = electron_1.screen.getDisplayNearestPoint(point), id = _a.id, bounds = _a.bounds;
-    // https://github.com/nashaofu/screenshots/issues/98
-    return {
-        id: id,
-        x: Math.floor(bounds.x),
-        y: Math.floor(bounds.y),
-        width: Math.floor(bounds.width),
-        height: Math.floor(bounds.height)
-    };
-});
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var electron_1 = require("electron");
+exports.default = (function () {
+    var point = electron_1.screen.getCursorScreenPoint();
+    var _a = electron_1.screen.getDisplayNearestPoint(point), id = _a.id, bounds = _a.bounds;
+    // https://github.com/nashaofu/screenshots/issues/98
+    return {
+        id: id,
+        x: Math.floor(bounds.x),
+        y: Math.floor(bounds.y),
+        width: Math.floor(bounds.width),
+        height: Math.floor(bounds.height)
+    };
+});

package/lib/index.d.ts

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