@hmcts/pdf-annotate

    1.1.17 • Public • Published

    hmcts/pdf-annotate.js (forked from instructure/pdf-annotate.js)

    build status Coverage Status

    A fork of pdf-annotate.js to fix issues with rotations

    Objectives

    • Provide a low level annotation layer for 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

    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.

    Documentation

    View the docs.

    Developing

    # clone the repo 
    $ git clone https://github.com/hmcts/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

    Install

    npm i @hmcts/pdf-annotate

    DownloadsWeekly Downloads

    52

    Version

    1.1.17

    License

    MIT

    Unpacked Size

    1.09 MB

    Total Files

    7

    Last publish

    Collaborators

    • timja
    • andrewwa-kainos
    • bendiggle
    • ellie-harrison
    • adrianc
    • hemantt
    • adamsilver
    • trevorsaint
    • timja-hmcts
    • dharmendrak
    • robertparkinson
    • pragnesh
    • damdun
    • p.jar
    • sabah.irfan
    • jenkins-reform-hmcts