@hmcts/annotation-ui-lib


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

$3

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

$3

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

for non document store files:
`
[baseUrl]="'http://localhost:3000/api'"
[annotate]="false"
[url]="'http://localhost:3000/assets/non-dm.pdf'"
[isDM]="false"
[contentType]="'pdf'">

`
Note: The file needs to be retrievable.



$3


- 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.