npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@hmcts/annotation-ui-lib

v1.0.23

Published

PDF Viewer and ability to highlight text with and comment tracking

Downloads

116

Readme

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