{"bugs":{"url":"https://github.com/ant-design/html2sketch"},"dist":{"shasum":"980dd18a001fbd17c97710ddf0f31e9a89e0902d","tarball":"https://registry.npmjs.org/html2sketch/-/html2sketch-0.4.4.tgz","fileCount":296,"integrity":"sha512-Y2ToJvRKBAoxQOzUrC8vAsymfsQ/PS9KGAayOpqI65CPPjLm/Z+g+E06xwKY1XAk9+1QfkvgsAzITq2w1Qm3Gw==","signatures":[{"sig":"MEUCIEEkmSaRyBH0YL/0t6U+kxvtp2UnEqeGvLhhAjdTgjXGAiEAjxMUChjgenco+uYJ52zT767lT4oWWkqrdv3HUueV9ZQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":3767520,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfkG9WCRA9TVsSAnZWagAAeA0QAJ6PRyQ2NfOAq2OJ6G1s\nkuN5gDE28Q5U6nMw5e9uktjwzYdF4V03Fn0RJZiCsuNAvGCRrOQr6I32yILi\nMc0zOX8eXBDrzU7JyGuALc5qykrhGV67P3C4tNsarbFqcz5T+7EHn3/KKmHo\nVnsG3VW3+w+LHrTre1aYZPMPjJ33Hs4tjKx9mZmB79HVlGkgzfIkIsjVfGZB\ny/NT6rhfNTPHy5WCr6wXpxk+JkNVFFocIyuUm3Wny1MCF9fu1jPclA7AnnQc\nQY7y7V8DyDDoBzY6Tv/vJntf8XHvve9/tjq8RYarI0sGisllnKfcB4kXz7PI\nx8aYWzGDE+hxV45yAPCj7DOkXbiCnLnJDAYU05xTV2B0NQbtoh0VDgmWYYl4\nuEIjyzOGe7dDwPkzlRpGM4M66Y4BGJkWLmpc+M/pm/X/eQjtLSXRPh68M4va\nmutAlKKQkrOSwGaVYXT1I01YmHjlQxbrZ5HM+N3zUigSVJpxzwtWqM0DeQjv\nsJs8tJSzaSXyCbasu9pG5DKHf+s+ffnRbjZxV5Q83XAJavnn8RjAcezhjlTt\nUlMVxUL5v6tDH2jSwWDE0msZDXO7amxioV0lUZUI2c9WqgFvvB2cBk29oBz1\nG9QF0bcxdyty0BkInPkgY++dj0ROIr7QIu/s6d33dHtFcha4YS41fE4eIzd9\nBzd3\r\n=dtfF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","name":"html2sketch","husky":{"hooks":{"commit-msg":"commitlint -E HUSKY_GIT_PARAMS","pre-commit":"npm run lint-staged"}},"types":"lib/index.d.ts","author":{"url":"arvinx@foxmail.com","name":"arvinxx"},"module":"es/index.js","readme":"<p align=\"center\">\n  <a href=\"https://github.com/ant-design/html2sketch\">\n   <img src=\"https://gw.alipayobjects.com/zos/antfincdn/9qm%24x99yzk/Logo.png\" height=\"200\" width=\"200\" alt=\"html2sketch\"/>\n  </a>\n</p>\n\n<h1 align=\"center\"><a href=\"https://ant-design.github.io/html2sketch/\">html2sketch</a></h1>\n\n<div align=\"center\">\n\n[![NPM version][npm-image]][npm-url] [![NPM version][npm-next-image]][npm-url] [![NPM downloads][download-image]][download-url] [![install size][npm-size]][npm-size-url]\n\n[![Test CI status][test-ci]][test-ci-url] ![Deploy CI][deploy-ci] [![Coverage][coverage]][codecov-url]\n\n[![david deps][david-image]][david-url] [![david devDeps][david-dev-image]][david-dev-url]\n\n[![ docs by dumi][dumi-url]](https://d.umijs.org/) [![Build With father][father-url]](https://github.com/umijs/father/)\n\n[![Gitpod ready-to-code][gitpod-badge]][gitpod-url]\n\n<!-- gitpod url -->\n\n[gitpod-badge]: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod\n[gitpod-url]: https://gitpod.io/#https://github.com/ant-design/html2sketch\n\n<!-- umi url -->\n\n[dumi-url]: https://img.shields.io/badge/docs%20by-dumi-blue\n[father-url]: https://img.shields.io/badge/build%20with-father-028fe4.svg\n\n<!-- npm url -->\n\n[npm-image]: http://img.shields.io/npm/v/html2sketch.svg?style=flat-square&color=deepgreen&label=latest\n[npm-next-image]: https://img.shields.io/npm/v/html2sketch/next?label=next&style=flat-square\n[npm-url]: http://npmjs.org/package/html2sketch\n[npm-size]: https://img.shields.io/bundlephobia/minzip/html2sketch?color=deepgreen&label=gizpped%20size&style=flat-square\n[npm-size-url]: https://packagephobia.com/result?p=html2sketch\n\n<!-- coverage -->\n\n[coverage]: https://codecov.io/gh/ant-design/html2sketch/branch/master/graph/badge.svg\n[codecov-url]: https://codecov.io/gh/ant-design/html2sketch/branch/master\n\n<!-- Github CI -->\n\n[test-ci]: https://github.com/ant-design/html2sketch/workflows/Test%20CI/badge.svg\n[deploy-ci]: https://github.com/ant-design/html2sketch/workflows/Deploy%20CI/badge.svg\n[test-ci-url]: https://github.com/ant-design/html2sketch/actions?query=workflow%3ATest%20CI\n[deploy-ci-ci]: https://github.com/ant-design/html2sketch/actions?query=workflow%3ADeploy%20CI\n[david-image]: https://img.shields.io/david/ant-design/html2sketch?style=flat-square\n[david-dev-url]: https://david-dm.org/ant-design/html2sketch?type=dev\n[david-dev-image]: https://img.shields.io/david/dev/ant-design/html2sketch?style=flat-square\n[david-url]: https://david-dm.org/ant-design/html2sketch\n[download-image]: https://img.shields.io/npm/dm/html2sketch.svg?style=flat-square\n[download-url]: https://npmjs.org/package/html2sketch\n\n</div>\n\n## 简介\n\n一个将 HTML 转 sketch 的模块\n\n## 快速上手\n\n### 安装\n\n```bash\nnpm i html2sketch --save\n```\n\n或\n\n```\nyarn add html2sketch\n```\n\n### 使用\n\n`html2sketch` 包含 3 个主要方法 `nodeToLayer` 、 `nodeToGroup` 和 `nodeToSketchSymbol` 。\n\n#### nodeToLayer\n\n将 DOM 节点转成 Sketch 的对象,转换时不处理节点的子级\n\n```js\nimport { nodeToLayer } from 'html2sketch';\n\nconst fn = async () => {\n  // 1. 获取 DOM 节点\n  const node = document.getElementById('id');\n\n  // 2. 调用转换方法\n  const layer = await nodeToLayer(node);\n\n  // 3. 生成为 Sketch JSON\n  const sketchJSON = layer.toSketchJSON();\n\n  return sketchJSON;\n};\n\nfn().then((json) => {\n  console.log(json);\n});\n```\n\n#### nodeToGroup\n\n将 DOM 节点以及它的子级整体转成 Sketch 的 Group 对象\n\n```js\nimport { nodeToGroup } from 'html2sketch';\n\nconst fn = async () => {\n  // 1. 获取 DOM 节点\n  const node = document.getElementById('id');\n\n  // 2. 调用转换方法\n  const group = await nodeToGroup(node);\n\n  // 3. 生成为 Sketch JSON\n  const sketchJSON = group.toSketchJSON();\n\n  return sketchJSON;\n};\n\nfn().then((json) => {\n  console.log(json);\n});\n```\n\n#### nodeToSketchSymbol\n\n将 DOM 节点转 Sketch 的 Symbol 对象\n\n```js\nimport { nodeToSketchSymbol } from 'html2sketch';\n\nconst fn = async () => {\n  // 1. 获取 DOM 节点\n  const node = document.getElementById('id');\n\n  // 2. 调用转换方法\n  const symbol = await nodeToSketchSymbol(node);\n\n  // 3. 生成为 Sketch JSON\n  const sketchJSON = symbol.toSketchJSON();\n\n  return sketchJSON;\n};\n\nfn().then((json) => {\n  console.log(json);\n});\n```\n\n## 有了 Sketch JSON 的下一步?\n\n生成的 Sketch JSON 严格符合 [Sketch File Format](https://developer.sketch.com/file-format/) 结构，因此只需要简单地将相应的 JSON 按照 Sketch 文件规范合成 `.sketch` 文件，即可获得 Sketch 文件。\n\n社区相关 API 模块:\n\n- [sketch-json-api](https://github.com/ant-design/sketch-json-api)\n- [node-sketch](https://github.com/oscarotero/node-sketch)\n- [sketch-constructor](https://github.com/amzn/sketch-constructor)\n\n如果希望直接使用该 JSON 对象，可以使用 [Sketch JSON](https://github.com/arvinxx/sketch-json) 插件，一键粘贴 JSON 进入 Sketch 中。\n\n## 开发\n\n查看 [开发指南](https://github.com/ant-design/html2sketch/guide)\n\n## License\n\n[MIT](./LICENSE)\n","engines":{"node":">=8.0.0"},"gitHead":"8fc94dda69ae3363cfe8aec5578a47d2ac607a76","license":"MIT","scripts":{"e2e":"npm run e2e:build && npm run e2e:online","tsc":"tsc -p tsconfig-check.json","lint":"npm run lint-eslint","test":"umi-test","build":"father-build && webpack","clean":"rm -rf es lib dist build coverage e2e/dist src/.umi* .eslintcache","start":"dumi dev","commit":"git-cz","publish":"npm publish","lint:fix":"eslint --fix --cache --ext .js,.jsx,.ts,.tsx --format=pretty ","prettier":"prettier -c --write \"**/**\"","---------":"","e2e:build":"UMI_ENV=e2e dumi build","e2e:local":"jest --config=jest.e2e.config.js","--------- ":"","e2e:online":"ONLINE=1 jest --config=jest.e2e.config.js","e2e:update":"UPDATE=1 ONLINE=1 jest --config=jest.e2e.config.js --update-snapshot","site:build":"dumi build","---------  ":"","lint-eslint":"eslint --cache --ext .js,.jsx,.ts,.tsx --format=pretty ./src","lint-staged":"lint-staged","test:update":"UPDATE=1 umi-test --update-snapshot","---------   ":"","publish:next":"npm publish --tag next","site:preview":"PREVIEW=1 dumi build","site:publish":"dumi build && gh-pages -d ./dist","---------    ":"","test:coverage":"umi-test --coverage","lint-staged:js":"eslint --cache --ext .js,.jsx,.ts,.tsx --format=pretty","prepublishOnly":"npm run test && npm run build && np --no-cleanup --yolo --no-publish --any-branch"},"_npmUser":{"name":"arvinxx","email":"arvinx@foxmail.com"},"homepage":"https://github.com/ant-design/html2sketch","keywords":["html","sketch","design","c2d"],"repository":{"url":"git+https://github.com/ant-design/html2sketch.git","type":"git"},"_npmVersion":"6.13.4","description":"parser HTML to Sketch","directories":{},"lint-staged":{"**/*.less":"stylelint --syntax less","**/*.{js,ts,tsx}":"npm run lint-staged:js","**/*.{js,jsx,tsx,ts,md,json}":["prettier --write","git add"]},"maintainers":[{"name":"arvinxx","email":"arvinx@foxmail.com"}],"_nodeVersion":"12.14.1","dependencies":{"css":"^3.0.0","uuid":"^8.2.0","color":"^3.1.2","svgson":"^4.1.0","svg-pathdata":"^5.0.5","svgo-browser":"^1.3.7","transformation-matrix":"^2.5.0","@sketch-hq/sketch-file-format-ts":"5.1.1"},"publishConfig":{"registry":"https://registry.npmjs.org"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"np":"^6.1.0","umi":"^3.0.0","dumi":"^1.0.13","jest":"^26.4.2","husky":"^4.0.0","konva":"^7.0.3","react":"^16.11.0","eslint":"^7.7.0","tslint":"^6.1.3","ts-jest":"^26.2.0","fs-extra":"^9.0.1","gh-pages":"^3.1.0","prettier":"^2.0.5","umi-test":"^1.9.6","cross-env":"^7.0.0","puppeteer":"^5.2.1","react-dom":"^16.11.0","stylelint":"^13.0.0","umi-types":"^0.5.11","@types/css":"0.0.31","commitizen":"^4.2.1","typescript":"^3.8.3","@babel/core":"^7.8.3","@types/jest":"^26.0.0","@types/uuid":"^8.3.0","@umijs/test":"^3.2.10","less-loader":"^6.0.0","lint-staged":"^10.0.2","react-konva":"^16.13.0-5","webpack-cli":"^3.3.12","@types/color":"^3.0.1","@types/jsdom":"^16.2.3","@types/react":"^16.9.17","babel-loader":"^8.1.0","concurrently":"^5.3.0","father-build":"^1.18.1","@umijs/fabric":"^2.2.2","jest-electron":"^0.1.11","enzyme-to-json":"^3.4.3","@commitlint/cli":"^9.1.2","@types/fs-extra":"^9.0.1","cz-customizable":"^6.2.1","react-json-view":"^1.19.1","@types/puppeteer":"^3.0.1","@types/react-dom":"^16.9.1","@babel/preset-env":"^7.8.3","@types/classnames":"^2.2.7","copy-to-clipboard":"^3.3.1","@ant-design/charts":"^0.9.13","@babel/preset-react":"^7.8.3","@umijs/preset-react":"1.x","babel-plugin-import":"^1.12.2","@ant-design/pro-card":"^1.3.1","commitlint-config-cz":"^0.13.1","@ant-design/pro-table":"^2.6.3","terser-webpack-plugin":"^3.0.2","@testing-library/react":"^10.0.2","tslint-config-prettier":"^1.18.0","umi-plugin-githubpages":"^2.0.0","mini-css-extract-plugin":"^0.9.0","@ant-design/pro-skeleton":"^1.0.0-beta.7","@babel/preset-typescript":"^7.8.3","@testing-library/react-hooks":"^3.2.1","eslint-import-resolver-alias":"^1.1.2","eslint-import-resolver-typescript":"^2.2.1","optimize-css-assets-webpack-plugin":"^5.0.3","@babel/plugin-proposal-object-rest-spread":"^7.8.3"},"_npmOperationalInternal":{"tmp":"tmp/html2sketch_0.4.4_1603301206291_0.9711075042898443","host":"s3://npm-registry-packages"},"_id":"html2sketch@0.4.4","version":"0.4.4"}