@hmcts/annotation-ui-lib
PDF Viewer and ability to highlight text with and comment tracking
$ cnpm install @hmcts/annotation-ui-lib 
SYNC missed versions from official npm registry.

@hmcts/annotation-ui-lib

Coverage Status Build Status

This is an angular library that provides components to view and annotate PDF documents, as well as view images.

Building annotation library

  • npm run package
  • distributable will be created under dist/annotation-ui-lib

Add as a dependency in your angular app

  • add @hmcts/annotation-ui-lib as a dependency in package.json

  • import HmctsEmViewerUiModule and declare it in your NgModule imports.

    For example:

    import { HmctsEmViewerUiModule } from 'annotation-ui-lib';
    
    @NgModule({
      imports: [
        ...,
        HmctsEmViewerUiModule,
      ]
    })
    
  • import assets to your angular.json

      {
          "glob": "**/*",
          "input": "node_modules/@hmcts/annotation-ui-lib/assets",
          "output": "/assets"
      }
    
  • and styles

    "styles": [
      "node_modules/@hmcts/annotation-ui-lib/assets/aui-styles.scss",
      ...
    ],
    
  • import JS dependencies as scripts within angular.json

    "scripts": [
        "node_modules/@hmcts/annotation-ui-lib/assets/js/pdf.combined.min.js",
        "node_modules/@hmcts/annotation-ui-lib/assets/js/pdf_viewer.min.js",
        "node_modules/@hmcts/annotation-ui-lib/assets/js/pdf-annotate.min.js"
        ...
    ]
    
  • component entry point:

    <app-document-viewer
        [baseUrl]="'http://localhost:3000/api'"
        [annotate]="true"
        [url]="'https://dm-store-aat.service.core-compute-aat.internal/documents/35f3714e-30e0-45d6-b4fb-08f51c271f8e'"
    ></app-document-viewer>
    

    for non document store files:

    <app-document-viewer
        [baseUrl]="'http://localhost:3000/api'"
        [annotate]="false"
        [url]="'http://localhost:3000/assets/non-dm.pdf'"
        [isDM]="false"
        [contentType]="'pdf'">
    </app-document-viewer>
    

    Note: The file needs to be retrievable.

Running development application (only for use with hmcts document store)

  • set environment variable to define if app connects to localhost or aat:
    export APP_ENV=local
    
  • start app server
    yarn install; export S2S_SECRET={{insert secret here}}; export IDAM_SECRET={{insert secret here}}; export APP_ENV=local; yarn start-dev-proxy;
    
  • start node server
    yarn install; export S2S_SECRET={{insert secret here}}; export IDAM_SECRET={{insert secret here}}; export APP_ENV=local; yarn watch-dev-node;
    
  • go to http://localhost:3000 and the viewer should load the document.

Current Tags

  • 1.0.23                                ...           latest (a year ago)

27 Versions

  • 1.0.23                                ...           a year ago
  • 1.0.22                                ...           a year ago
  • 1.0.21                                ...           a year ago
  • 1.0.20                                ...           a year ago
  • 1.0.19                                ...           a year ago
  • 1.0.19-RC                                ...           a year ago
  • 1.0.18                                ...           a year ago
  • 1.0.18-RC                                ...           a year ago
  • 1.0.17                                ...           a year ago
  • 1.0.17-RC                                ...           a year ago
  • 1.0.16                                ...           a year ago
  • 1.0.16-RC                                ...           a year ago
  • 1.0.15                                ...           a year ago
  • 1.0.15-RC                                ...           a year ago
  • 1.0.14-RC                                ...           a year ago
  • 1.0.13                                ...           a year ago
  • 1.0.13-RC                                ...           a year ago
  • 1.0.11-RC                                ...           a year ago
  • 1.0.10-RC                                ...           a year ago
  • 1.0.9-RC                                ...           a year ago
  • 1.0.7-RC                                ...           a year ago
  • 1.0.6-RC                                ...           a year ago
  • 1.0.5-RC                                ...           a year ago
  • 1.0.4-RC                                ...           a year ago
  • 1.0.3-RC                                ...           a year ago
  • 1.0.2-RC                                ...           a year ago
  • 1.0.1                                ...           a year ago

Copyright 2014 - 2016 © taobao.org |