161 lines
4.1 KiB
Markdown
161 lines
4.1 KiB
Markdown
<h1 align="center">modern-screenshot</h1>
|
||
|
||
<p align="center">
|
||
<a href="https://unpkg.com/modern-screenshot">
|
||
<img src="https://img.shields.io/bundlephobia/minzip/modern-screenshot" alt="Minzip">
|
||
</a>
|
||
<a href="https://www.npmjs.com/package/modern-screenshot">
|
||
<img src="https://img.shields.io/npm/v/modern-screenshot.svg" alt="Version">
|
||
</a>
|
||
<a href="https://www.npmjs.com/package/modern-screenshot">
|
||
<img src="https://img.shields.io/npm/dm/modern-screenshot" alt="Downloads">
|
||
</a>
|
||
<a href="https://github.com/qq15725/modern-screenshot/issues">
|
||
<img src="https://img.shields.io/github/issues/qq15725/modern-screenshot" alt="Issues">
|
||
</a>
|
||
<a href="https://github.com/qq15725/modern-screenshot/blob/master/LICENSE">
|
||
<img src="https://img.shields.io/npm/l/modern-screenshot.svg" alt="License">
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">使用 HTML5 canvas 和 SVG 从 DOM 节点快速生成图像</p>
|
||
|
||
<p align="center">Fork from <a href="https://github.com/bubkoo/html-to-image">html-to-image</a></p>
|
||
|
||
<p align="center"><a href="README.md">English</a> | 简体中文</p>
|
||
|
||
## 📦 安装
|
||
|
||
```sh
|
||
npm i modern-screenshot
|
||
```
|
||
|
||
## 🦄 使用
|
||
|
||
```ts
|
||
import { domToPng } from 'modern-screenshot'
|
||
|
||
domToPng(document.querySelector('#app')).then(dataUrl => {
|
||
const link = document.createElement('a')
|
||
link.download = 'screenshot.png'
|
||
link.href = dataUrl
|
||
link.click()
|
||
})
|
||
```
|
||
|
||
<details>
|
||
<summary>CDN</summary><br>
|
||
|
||
```html
|
||
<script src="https://unpkg.com/modern-screenshot"></script>
|
||
<script>
|
||
modernScreenshot.domToPng(document.querySelector('body')).then(dataUrl => {
|
||
const link = document.createElement('a')
|
||
link.download = 'screenshot.png'
|
||
link.href = dataUrl
|
||
link.click()
|
||
})
|
||
</script>
|
||
```
|
||
|
||
<br></details>
|
||
|
||
<details>
|
||
<summary>浏览器控制台</summary><br>
|
||
|
||
> ⚠️ 由于 CORS 部分嵌入将失败
|
||
|
||
```js
|
||
const script = document.createElement('script')
|
||
script.src = "https://unpkg.com/modern-screenshot"
|
||
document.getElementsByTagName('head')[0].appendChild(script)
|
||
|
||
script.onload = () => {
|
||
modernScreenshot
|
||
.domToImage(document.querySelector('body'), {
|
||
debug: true,
|
||
progress: (current, total) => {
|
||
console.log(`${ current }/${ total }`)
|
||
}
|
||
})
|
||
.then(img => {
|
||
const width = 600
|
||
const height = img.height * (width / img.width)
|
||
console.log('%c ', [
|
||
`padding: 0 ${ width / 2 }px;`,
|
||
`line-height: ${ height }px;`,
|
||
`background-image: url('${ img.src }');`,
|
||
`background-size: 100% 100%;`,
|
||
].join(''))
|
||
})
|
||
}
|
||
```
|
||
|
||
<br></details>
|
||
|
||
## 方法
|
||
|
||
> `method(node: Node, options?: Options)`
|
||
|
||
DOM 转 dataURL
|
||
|
||
- [domToPng](src/converts/dom-to-png.ts)
|
||
- [domToSvg](src/converts/dom-to-svg.ts)
|
||
- [domToJpeg](src/converts/dom-to-jpeg.ts)
|
||
- [domToWebp](src/converts/dom-to-webp.ts)
|
||
- [domToDataUrl](src/converts/dom-to-data-url.ts)
|
||
|
||
DOM 转 data
|
||
|
||
- [domToBlob](src/converts/dom-to-blob.ts)
|
||
- [domToPixel](src/converts/dom-to-pixel.ts)
|
||
|
||
DOM 转 HTMLElement
|
||
|
||
- [domToForeignObjectSvg](src/converts/dom-to-foreign-object-svg.ts)
|
||
- [domToImage](src/converts/dom-to-image.ts)
|
||
- [domToCanvas](src/converts/dom-to-canvas.ts)
|
||
|
||
## 选项
|
||
|
||
请查看 [options.ts](src/options.ts)
|
||
|
||
## 单例上下文和 web worker
|
||
|
||
通过重用上下文和 web worker，每秒快速截图
|
||
|
||
```ts
|
||
// use vite
|
||
import workerUrl from 'modern-screenshot/worker?url'
|
||
import { createContext, destroyContext, domToPng } from 'modern-screenshot'
|
||
|
||
async function screenshotsPerSecond() {
|
||
const context = await createContext(document.querySelector('#app'), {
|
||
workerUrl,
|
||
workerNumber: 1,
|
||
})
|
||
for (let i = 0; i < 10; i++) {
|
||
domToPng(context).then(dataUrl => {
|
||
const link = document.createElement('a')
|
||
link.download = `screenshot-${ i + 1 }.png`
|
||
link.href = dataUrl
|
||
link.click()
|
||
if (i + 1 === 10) {
|
||
destroyContext(context)
|
||
}
|
||
})
|
||
await new Promise(resolve => setTimeout(resolve, 1000))
|
||
}
|
||
}
|
||
|
||
screenshotsPerSecond()
|
||
```
|
||
|
||
请查看 [context.ts](src/context.ts)
|
||
|
||
## 待办事项
|
||
|
||
- [ ] 无法克隆 [css 计数器](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Counter_Styles/Using_CSS_counters)
|
||
|
||
`content: counter(step);`
|