# modern-screenshot

> Quickly generate image from DOM node using HTML5 canvas and SVG

Latest version **4.7.0** (published 2026-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install modern-screenshot
pnpm add modern-screenshot
yarn add modern-screenshot
bun add modern-screenshot
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.7.0 |
| Published | 2026-04-16 |
| First published | 2022-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 181.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| Author | wxm |
| Maintainers | wengxiangmin |
| Keywords | dom, image, raster, render, html, canvas, svg, screenshot, modern |

## Links

- npm: https://www.npmjs.com/package/modern-screenshot
- Repository: https://github.com/qq15725/modern-screenshot
- Issues: https://github.com/qq15725/modern-screenshot/issues
- npm.io page: https://npm.io/package/modern-screenshot

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 4.7.0 (latest) — 2026-04-16
- 4.6.8 — 2026-01-26
- 4.6.7 — 2025-11-18
- 4.6.6 — 2025-08-19
- 4.6.5 — 2025-07-05
- 4.6.4 — 2025-06-12
- 4.6.3 — 2025-06-12
- 4.6.2 — 2025-06-09
- 4.6.1 — 2025-06-09
- 4.6.0 — 2025-02-13
- 4.5.5 — 2024-12-01
- 4.5.4 — 2024-11-12
- 4.5.3 — 2024-11-12
- 4.5.2 — 2024-11-09
- 4.5.1 — 2024-11-06
- … 76 more at https://npm.io/package/modern-screenshot/versions

## README

<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">Quickly generate image from DOM node using HTML5 canvas and SVG</p>

<p align="center">Fork from <a href="https://github.com/bubkoo/html-to-image">html-to-image</a></p>

<p align="center">English | <a href="README.zh-CN.md">简体中文</a></p>

## 📦 Install

```sh
npm i modern-screenshot
```

## 🦄 Usage

```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>Browser Console</summary><br>

> ⚠️ Partial embedding will fail due to CORS

```js
const script = document.createElement('script')
script.src = 'https://unpkg.com/modern-screenshot/dist/index.js'
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>

## Methods

> `method(node: Node, options?: Options)`

DOM to 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 to data

- [domToBlob](src/converts/dom-to-blob.ts)
- [domToPixel](src/converts/dom-to-pixel.ts)

DOM to 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

See the [options.ts](src/options.ts)

## Singleton context and web worker

Quick screenshots per second by reusing context and web worker

```ts
import { createContext, destroyContext, domToPng } from 'modern-screenshot'
// use vite
import workerUrl from 'modern-screenshot/worker?url'

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()
```

See the [context.ts](src/context.ts)

## TODO

- [ ] unable to clone [css counters](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Counter_Styles/Using_CSS_counters)

  `content: counter(step);`

---
_Source: https://npm.io/package/modern-screenshot · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._