{"id":13484926,"url":"https://github.com/qq15725/modern-screenshot","last_synced_at":"2025-05-13T19:06:24.014Z","repository":{"id":41159349,"uuid":"504195027","full_name":"qq15725/modern-screenshot","owner":"qq15725","description":"📸 Quickly generate image from DOM node using HTML5 canvas and SVG.","archived":false,"fork":false,"pushed_at":"2025-02-13T03:01:47.000Z","size":4864,"stargazers_count":1283,"open_issues_count":53,"forks_count":60,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-09T22:05:41.805Z","etag":null,"topics":["canvas","dom","dom-to-image","html-to-image","html2canvas","image","javascript","modern-screenshot","screenshot","svg","typescript"],"latest_commit_sha":null,"homepage":"https://toolpkg.com/html-to-image","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qq15725.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-16T14:49:30.000Z","updated_at":"2025-05-06T05:37:05.000Z","dependencies_parsed_at":"2023-11-16T04:24:34.649Z","dependency_job_id":"900fb798-084e-4bee-8537-16228ace6177","html_url":"https://github.com/qq15725/modern-screenshot","commit_stats":{"total_commits":332,"total_committers":9,"mean_commits":"36.888888888888886","dds":0.03614457831325302,"last_synced_commit":"7647a4feb3379b2c29e6d0620c5ae6efd9d82ab1"},"previous_names":[],"tags_count":100,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qq15725%2Fmodern-screenshot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qq15725%2Fmodern-screenshot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qq15725%2Fmodern-screenshot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qq15725%2Fmodern-screenshot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qq15725","download_url":"https://codeload.github.com/qq15725/modern-screenshot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253404983,"owners_count":21903110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["canvas","dom","dom-to-image","html-to-image","html2canvas","image","javascript","modern-screenshot","screenshot","svg","typescript"],"created_at":"2024-07-31T17:01:39.012Z","updated_at":"2025-05-13T19:06:23.982Z","avatar_url":"https://github.com/qq15725.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","canvas","🎨 Design \u0026 Creative"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003emodern-screenshot\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://unpkg.com/modern-screenshot\"\u003e\n    \u003cimg src=\"https://img.shields.io/bundlephobia/minzip/modern-screenshot\" alt=\"Minzip\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/modern-screenshot\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/modern-screenshot.svg\" alt=\"Version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/modern-screenshot\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/modern-screenshot\" alt=\"Downloads\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/qq15725/modern-screenshot/issues\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/qq15725/modern-screenshot\" alt=\"Issues\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/qq15725/modern-screenshot/blob/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/modern-screenshot.svg\" alt=\"License\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eQuickly generate image from DOM node using HTML5 canvas and SVG\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eFork from \u003ca href=\"https://github.com/bubkoo/html-to-image\"\u003ehtml-to-image\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eEnglish | \u003ca href=\"README.zh-CN.md\"\u003e简体中文\u003c/a\u003e\u003c/p\u003e\n\n## 📦 Install\n\n```sh\nnpm i modern-screenshot\n```\n\n## 🦄 Usage\n\n```ts\nimport { domToPng } from 'modern-screenshot'\n\ndomToPng(document.querySelector('#app')).then(dataUrl =\u003e {\n  const link = document.createElement('a')\n  link.download = 'screenshot.png'\n  link.href = dataUrl\n  link.click()\n})\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eCDN\u003c/summary\u003e\u003cbr\u003e\n\n```html\n\u003cscript src=\"https://unpkg.com/modern-screenshot\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  modernScreenshot.domToPng(document.querySelector('body')).then(dataUrl =\u003e {\n    const link = document.createElement('a')\n    link.download = 'screenshot.png'\n    link.href = dataUrl\n    link.click()\n  })\n\u003c/script\u003e\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eBrowser Console\u003c/summary\u003e\u003cbr\u003e\n\n\u003e ⚠️ Partial embedding will fail due to CORS\n\n```js\nconst script = document.createElement('script')\nscript.src = \"https://unpkg.com/modern-screenshot\"\ndocument.getElementsByTagName('head')[0].appendChild(script)\n\nscript.onload = () =\u003e {\n  modernScreenshot\n    .domToImage(document.querySelector('body'), {\n      debug: true,\n      progress: (current, total) =\u003e {\n        console.log(`${ current }/${ total }`)\n      }\n    })\n    .then(img =\u003e {\n      const width = 600\n      const height = img.height * (width / img.width)\n      console.log('%c ', [\n        `padding: 0 ${ width / 2 }px;`,\n        `line-height: ${ height }px;`,\n        `background-image: url('${ img.src }');`,\n        `background-size: 100% 100%;`,\n      ].join(''))\n    })\n}\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n## Methods\n\n\u003e `method(node: Node, options?: Options)`\n\nDOM to dataURL\n\n- [domToPng](src/converts/dom-to-png.ts)\n- [domToSvg](src/converts/dom-to-svg.ts)\n- [domToJpeg](src/converts/dom-to-jpeg.ts)\n- [domToWebp](src/converts/dom-to-webp.ts)\n- [domToDataUrl](src/converts/dom-to-data-url.ts)\n\nDOM to data\n\n- [domToBlob](src/converts/dom-to-blob.ts)\n- [domToPixel](src/converts/dom-to-pixel.ts)\n\nDOM to HTMLElement\n\n- [domToForeignObjectSvg](src/converts/dom-to-foreign-object-svg.ts)\n- [domToImage](src/converts/dom-to-image.ts)\n- [domToCanvas](src/converts/dom-to-canvas.ts)\n\n## Options\n\nSee the [options.ts](src/options.ts)\n\n## Singleton context and web worker\n\nQuick screenshots per second by reusing context and web worker\n\n```ts\n// use vite\nimport workerUrl from 'modern-screenshot/worker?url'\nimport { createContext, destroyContext, domToPng } from 'modern-screenshot'\n\nasync function screenshotsPerSecond() {\n  const context = await createContext(document.querySelector('#app'), {\n    workerUrl,\n    workerNumber: 1,\n  })\n  for (let i = 0; i \u003c 10; i++) {\n    domToPng(context).then(dataUrl =\u003e {\n      const link = document.createElement('a')\n      link.download = `screenshot-${ i + 1 }.png`\n      link.href = dataUrl\n      link.click()\n      if (i + 1 === 10) {\n        destroyContext(context)\n      }\n    })\n    await new Promise(resolve =\u003e setTimeout(resolve, 1000))\n  }\n}\n\nscreenshotsPerSecond()\n```\n\nSee the [context.ts](src/context.ts)\n\n## TODO\n\n- [ ] unable to clone [css counters](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Counter_Styles/Using_CSS_counters)\n\n  `content: counter(step);`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqq15725%2Fmodern-screenshot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqq15725%2Fmodern-screenshot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqq15725%2Fmodern-screenshot/lists"}