Skip to content

@neosjs/screen-shot ​

纯 JS 实现的网页截屏插件,基于 Canvas 绘制。支持方形/圆形截取、画笔、马赛克笔、文字标注、撤销等工具,可定制工具栏图标与位置,截取结果以 base64 回调返回,兼容鼠标与触摸操作。

安装 ​

sh
pnpm add @neosjs/screen-shot
sh
npm i @neosjs/screen-shot
sh
yarn add @neosjs/screen-shot

快速上手 ​

引入组件与样式后,创建 ScreenShot 实例即可唤起截屏;通过 onComplete 回调获取截取结果:

ts
import ScreenShot from '@neosjs/screen-shot'
import '@neosjs/screen-shot/dist/index.css'

let screenShoter: ScreenShot | null = null

function screen() {
  screenShoter = new ScreenShot({
    cutDotColor: '#1da750',
    cutDotSize: 6,
    cutDotRound: true,
    toolPosition: 'right',
    confirmBtnText: '完成',
    showToolIcon: ['save'],
    onComplete: ({ base64 }) => {
      console.log(base64)
    },
    onSave: (code: number, msg: string) => {
      console.log(code, msg)
    },
    onLoaded: (res) => {
      console.log(res, '截图组件加载完毕')
    },
    onClose: () => {
      console.log('关闭截图')
    }
  })
}

// 确认截图
function complete() {
  screenShoter && screenShoter.complete()
}

// 销毁
function destroy() {
  screenShoter && screenShoter.destroy()
}

API ​

参数 ​

参数说明类型可选值默认值
enableWebRtc是否启用 WebRtcboolean-false
webrtcWindowMode是否启用窗口截图模式,默认为当前标签页截图boolean-false
level截图容器层级number-99999
canvasWidth画布宽度(必须与高度一起设置,单独设置无效)number--
canvasHeight画布高度(必须与宽度一起设置,单独设置无效)number--
dpr画布像素比number-window.devicePixelRatio
lockScroll是否锁定滚动条boolean-true
position截图框位置object{ top: 0, left: 0 }-
clickCutFullScreen点击截图框是否全屏boolean-false
screenShotDom需要进行截图的容器HTMLElement | HTMLDivElement | HTMLCanvasElement--
maskColor遮罩颜色string-rgba(0, 0, 0, 0.5)
saveImgTitle保存图片时的文件名string-当前时间戳
cutDotColor截图点颜色string-#6cb6ff
cutDotSize截图点大小number-6
cutDotRound截图点是否圆角boolean-false
showScreenData是否显示截图数据boolean-false
toolPosition工具栏位置stringleft / right / centerright
confirmBtnText确认按钮文案string--
showToolIcon显示的工具栏图标string[]见「工具栏图标定制」['close', 'confirm']
imgSrc截图图片地址string--
loadCrossImg是否加载跨域图片boolean-false
cropBoxInfo截图框信息object{ width: 200, height: 200, x: 0, y: 0 }-
onComplete截图完成回调(res: { base64: string }) => void--
onSave保存回调(code: number, msg: string) => void--
onLoaded加载完成回调(res: any) => void--
onClose关闭回调() => void--
rightClickEvent右键事件{ state: boolean, handler?: () => void }--

TIP

如果未配置 onComplete 回调,点击确认截图返回的 base64 数据将存储在 sessionStorage 中,key 为 screenShotImg,可通过 sessionStorage.getItem('screenShotImg') 获取。

方法 ​

方法说明
complete()确认截图
destroy()销毁截图组件

快捷键 ​

快捷键说明
Ctrl/Command + Z等同于点击截图工具栏的撤销图标
Esc等同于点击工具栏的关闭图标
Enter等同于点击工具栏的确认图标

工具栏图标定制 ​

通过配置 showToolIcon 定制工具栏图标,可选值如下:

名称说明
square方形截图
round圆形截图
brush画笔
mosaicPen马赛克笔
text文字
undo撤销
confirm确认
right-top右上角
separateLine分割线
save保存
close关闭