{"_id":"pdf-annotate.js","_rev":"3-5bf2b9232787ff5e4c00db1d5088b9e9","name":"pdf-annotate.js","description":"Annotation layer for pdf.js","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"pdf-annotate.js","version":"1.0.0","description":"Annotation layer for pdf.js","main":"dist/pdf-annotate.js","scripts":{"test":"karma start --single-run","start":"bash scripts/web","build":"MINIFY=1 webpack","coveralls":"cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"},"files":["dist"],"repository":{"type":"git","url":"git+https://github.com/instructure/pdf-annotate.js.git"},"keywords":["pdf","annotation"],"author":{"name":"Matt Zabriskie"},"license":"MIT","bugs":{"url":"https://github.com/instructure/pdf-annotate.js/issues"},"homepage":"https://github.com/instructure/pdf-annotate.js#readme","devDependencies":{"babel-core":"6.7.4","babel-loader":"6.2.4","babel-plugin-add-module-exports":"^0.2.1","babel-preset-es2015":"^6.6.0","chai":"^3.5.0","coveralls":"^2.11.9","istanbul-instrumenter-loader":"^0.2.0","karma":"^0.13.22","karma-cli":"^0.1.2","karma-coverage":"^0.5.5","karma-firefox-launcher":"^0.1.7","karma-mocha":"^0.2.2","karma-sinon-chai":"^1.2.0","karma-sourcemap-loader":"^0.3.7","karma-webpack":"^1.7.0","lolex":"^1.4.0","mocha":"^2.4.5","object-assign":"^4.0.1","pdfjs-dist":"1.4.162","simulant":"^0.2.0","sinon":"^1.17.3","sinon-chai":"^2.8.0","twitter-text":"^1.13.4","webpack":"1.12.14","webpack-dev-server":"1.14.1"},"dependencies":{"create-stylesheet":"^0.3.0","object-assign":"^4.0.1"},"directories":{"doc":"docs","test":"test"},"gitHead":"1398f8c624fb1a6fd949d04728532bfacabd7e3d","_id":"pdf-annotate.js@1.0.0","_shasum":"f42f407781f6dd99047d1b4390043a087a89229f","_from":".","_npmVersion":"3.10.3","_nodeVersion":"6.4.0","_npmUser":{"name":"taislam","email":"tq.ulislam@gmail.com"},"dist":{"shasum":"f42f407781f6dd99047d1b4390043a087a89229f","tarball":"https://registry.npmjs.org/pdf-annotate.js/-/pdf-annotate.js-1.0.0.tgz","integrity":"sha512-4KGoz7Yk69CtXOhoAoZcFKLQYMdURMOJ86daHJfqGjaloGCBIR0WOmi6IK98dX+vIaTctCT7iLDjoyxu5do1BQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFTg1ejifniIkmZ+49IOCYb1NrCTfufMCFZZ5MVJsSoeAiEAiXY0oiaqEiq6MbYB4xwZJPdba8HSLl2A4DS6gopksx8="}]},"maintainers":[{"name":"taislam","email":"tq.ulislam@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/pdf-annotate.js-1.0.0.tgz_1475389103773_0.9362847781740129"}}},"readme":"# pdf-annotate.js\r\n\r\n[![build status](https://img.shields.io/travis/instructure/pdf-annotate.js.svg?style=flat-square)](https://travis-ci.org/instructure/pdf-annotate.js)\r\n[![code coverage](https://img.shields.io/coveralls/instructure/pdf-annotate.js.svg?style=flat-square)](https://coveralls.io/r/instructure/pdf-annotate.js)\r\n\r\nAnnotation layer for [pdf.js](https://github.com/mozilla/pdf.js)\r\n\r\n## Objectives\r\n\r\n- Provide a low level annotation layer for [pdf.js](https://github.com/mozilla/pdf.js).\r\n- Optional high level UI for managing annotations.\r\n- Agnostic of backend, just supply your own `StoreAdapter` to fetch/store data.\r\n- Prescribe annotation format.\r\n\r\n## Example\r\n\r\n```js\r\nimport __pdfjs from 'pdfjs-dist/build/pdf';\r\nimport PDFJSAnnotate from 'pdfjs-annotate';\r\nimport MyStoreAdapter from './myStoreAdapter';\r\n\r\nconst { UI } = PDFJSAnnotate;\r\nconst VIEWER = document.getElementById('viewer');\r\nconst RENDER_OPTIONS = {\r\n  documentId: 'MyPDF.pdf',\r\n  pdfDocument: null,\r\n  scale: 1,\r\n  rotate: 0\r\n};\r\n\r\nPDFJS.workerSrc = 'pdf.worker.js';\r\nPDFJSAnnotate.setStoreAdapter(MyStoreAdapter);\r\n\r\nPDFJS.getDocument(RENDER_OPTIONS.documentId).then((pdf) => {\r\n  RENDER_OPTIONS.pdfDocument = pdf;\r\n  VIEWER.appendChild(UI.createPage(1));\r\n  UI.renderPage(1, RENDER_OPTIONS);\r\n});\r\n```\r\n\r\nSee more [examples](https://github.com/instructure/pdf-annotate.js/blob/master/web/index.js).\r\n\r\n## Documentation\r\n\r\n[View the docs](https://github.com/instructure/pdf-annotate.js/tree/master/docs).\r\n\r\n## Developing\r\n\r\n```bash\r\n# clone the repo\r\n$ git clone https://github.com/instructure/pdf-annotate.js.git\r\n$ cd pdf-annotate.js\r\n\r\n# intall dependencies\r\n$ npm install\r\n\r\n# start example server\r\n$ npm start\r\n$ open http://127.0.0.1:8080\r\n\r\n# run tests\r\n$ npm test\r\n```\r\n## License\r\n\r\nMIT\r\n","maintainers":[{"name":"taislam","email":"tq.ulislam@gmail.com"}],"time":{"modified":"2022-06-23T16:31:03.609Z","created":"2016-10-02T06:18:25.655Z","1.0.0":"2016-10-02T06:18:25.655Z"},"homepage":"https://github.com/instructure/pdf-annotate.js#readme","keywords":["pdf","annotation"],"repository":{"type":"git","url":"git+https://github.com/instructure/pdf-annotate.js.git"},"author":{"name":"Matt Zabriskie"},"bugs":{"url":"https://github.com/instructure/pdf-annotate.js/issues"},"license":"MIT","readmeFilename":"README.md"}