https://github.com/instructure/pdf-annotate.js

Annotation layer for pdf.js (no longer maintained)
https://github.com/instructure/pdf-annotate.js

Last synced: 13 days ago
JSON representation

Annotation layer for pdf.js (no longer maintained)

• Host: GitHub
• URL: https://github.com/instructure/pdf-annotate.js
• Owner: instructure
• License: mit
• Archived: true
• Created: 2015-08-20T18:18:05.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-12-21T17:38:16.000Z (almost 6 years ago)
• Last Synced: 2024-10-22T16:53:43.852Z (22 days ago)
• Language: JavaScript
• Homepage: http://instructure.github.io/pdf-annotate.js/
• Size: 1.94 MB
• Stars: 545
• Watchers: 32
• Forks: 277
• Open Issues: 56
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pdf-annotate.js (no longer maintained)

[![build status](https://img.shields.io/travis/instructure/pdf-annotate.js.svg?style=flat-square)](https://travis-ci.org/instructure/pdf-annotate.js)

[![code coverage](https://img.shields.io/coveralls/instructure/pdf-annotate.js.svg?style=flat-square)](https://coveralls.io/r/instructure/pdf-annotate.js)

Annotation layer for [pdf.js](https://github.com/mozilla/pdf.js)

## Objectives

- Provide a low level annotation layer for [pdf.js](https://github.com/mozilla/pdf.js).

- Optional high level UI for managing annotations.

- Agnostic of backend, just supply your own `StoreAdapter` to fetch/store data.

- Prescribe annotation format.

## Example

```js

import __pdfjs from 'pdfjs-dist/build/pdf';

import PDFJSAnnotate from 'pdfjs-annotate';

import MyStoreAdapter from './myStoreAdapter';

const { UI } = PDFJSAnnotate;

const VIEWER = document.getElementById('viewer');

const RENDER_OPTIONS = {

  documentId: 'MyPDF.pdf',

  pdfDocument: null,

  scale: 1,

  rotate: 0

};

PDFJS.workerSrc = 'pdf.worker.js';

PDFJSAnnotate.setStoreAdapter(MyStoreAdapter);

PDFJS.getDocument(RENDER_OPTIONS.documentId).then((pdf) => {

  RENDER_OPTIONS.pdfDocument = pdf;

  VIEWER.appendChild(UI.createPage(1));

  UI.renderPage(1, RENDER_OPTIONS);

});

```

See more [examples](https://github.com/instructure/pdf-annotate.js/blob/master/web/index.js).

## Documentation

[View the docs](https://github.com/instructure/pdf-annotate.js/tree/master/docs).

## Developing

```bash

# clone the repo

$ git clone https://github.com/instructure/pdf-annotate.js.git

$ cd pdf-annotate.js

# intall dependencies

$ npm install

# start example server

$ npm start

$ open http://127.0.0.1:8080

# run tests

$ npm test

```

## License

MIT