Annotations?

[TerryOS]

Fantastic PDFViewer, was using Syncfusion before finding this and this a million times faster!

Does the viewer currently support rendering PDF annotation objects (e.g., rectangle / square / highlight / link annotations), or exposing any metadata so we can detect clicks on them?

If not, is there a recommended way to add custom overlay rectangles aligned to the PDF pages (e.g., access to page size, zoom level, and scroll position)?

Thanks!

[tgothorp]

Hello, thank you for the feedback 🎉

Annotations are not currently supported. I can't think of a good way to add custom overlays though if you really needed do then you might be able to get away with it by having the PDF viewer in single page mode, reading the dimensions of the pdf <canvas> and the page number element though I think this would quickly get unmanageable.

I will investigate getting annotations working though this could take some time.

[TerryOS]

My guess is that adding Annotations would be a massive headache, would be a killer feature though if done right! Right now I will have to do that on the server and just feed them back to the client.

As a potential poor mans alternative is there a way to programatically hightlight text?

And... last question - is there a way to programatically navigate between pages? The only way I could get it to work was the following:

_mudPdfViewer.SetPdfViewerMetaData(new PdfViewerModel   
{   
    CurrentPage = firstBox.PageNumber,   
    TotalPages = _mudPdfViewer.PdfFile!.Paging.TotalPages   
});  
  
StateHasChanged();  

[tgothorp]

Have added basic annotation support in version 2.2.0

I'd eventually like to have a tighter integration with annotations (ie. PDF forms triggering something in Blazor) but this will suffice for now.

More info on the documentation page

[dfyx]

I would love to have support for annotations that don't come directly from the PDF but from a separate API, similar to what https://github.com/jhubert/stimulus-pdf-viewer does.

My use case is that I'm building a viewer for my library of TTRPG rule books where every player in my group might have their own private notes in each PDF or I as the dungeon master might have different notes for different campaigns.

API-wise this could be exposed as a property ExternalAnnotations and a couple of events when annotations are created, deleted or updated. That way, it wouldn't be limited to a fixed REST scheme like stimulus is.