@mkhuda/dom-screenshot 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -4
  2. package/package.json +1 -2
package/README.md CHANGED
@@ -1,20 +1,36 @@
1
1
  # dom-screenshot
2
+ [![Build Status](https://app.travis-ci.com/mkhuda/dom-screenshot.svg?branch=main)](https://app.travis-ci.com/mkhuda/dom-screenshot) [![npm version](https://badge.fury.io/js/%40mkhuda%2Fdom-screenshot.svg)](https://badge.fury.io/js/%40mkhuda%2Fdom-screenshot)
3
+
2
4
  DOM screenshot by dom-to-image forked & modified from [dom-to-image](https://github.com/tsayen/dom-to-image)
3
5
 
4
- ## Added Fix:
5
- - Add encodeURIComponent on makeSvgDataUri. Based on (this)[https://github.com/tsayen/dom-to-image/issues/78] issue
6
+ ## Install
7
+ ```bash
8
+ # YARN
9
+ yarn add @mkhuda/dom-screenshot
10
+ # NPM
11
+ npm install @mkhuda/dom-screenshot
12
+ ```
13
+
14
+
15
+ ## Added & Fix:
16
+ - Change to rollup build
17
+ - Add encodeURIComponent on makeSvgDataUri. Based on [this](https://github.com/tsayen/dom-to-image/issues/78) issue
6
18
  - Add Typescript support, (.d.ts) battery included.
7
19
 
20
+ ## TODO (on progress):
21
+ - Full rewrite to Typescript
22
+ - Adding `chai` test (on progress).
23
+
8
24
  ## Usages (React)
9
25
  ```typescript
10
- import DomToImage from "@mkhuda/dom-screenshot";
26
+ import DomScreenshot from "@mkhuda/dom-screenshot";
11
27
  ....
12
28
 
13
29
  return(
14
30
  <button
15
31
  onClick={() => {
16
32
  const getElement = document.getElementById("root") as HTMLElement;
17
- const image = DomToImage.toPng(document.body, {});
33
+ const image = DomScreenshot.toPng(document.body, {});
18
34
  image.then((generatedImage) => {
19
35
  window.open(generatedImage);
20
36
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mkhuda/dom-screenshot",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "DOM screenshot by dom-to-image",
5
5
  "main": "dist/dom-screenshot.min.js",
6
6
  "types": "dist/dom-screenshot.d.ts",
@@ -11,7 +11,6 @@
11
11
  "build": "rimraf dist && rollup -c --perf",
12
12
  "build-dts": "npx -p typescript tsc src/dom-screenshot.js --declaration --allowJs --emitDeclarationOnly --outDir types",
13
13
  "start": "yarn build",
14
- "test": "jest",
15
14
  "watch": "rollup -c --watch"
16
15
  },
17
16
  "devDependencies": {