search

ApryseSDK / webviewer-ui

WebViewer UI built in React
Other
416 stars 354 forks source link

[Bug] TypeScript Error: Property 'customHandlerId' Not Recognized in '@pdftron/webviewer' Method 'instance.UI.loadDocument #1046

Open ToriaHUB opened 9 months ago

ToriaHUB commented 9 months ago

Description

I am currently using @pdftron/webviewer version 10.7.1 in my project. I encountered an issue where TypeScript does not recognize the customHandlerId property in the instance.UI.loadDocument method.

WebViewer version 10.7.1

The current behavior TypeScript does not recognize customHandlerId as a valid property in the instance.UI.loadDocument method and throws an error.

The expected behavior customHandlerId should be recognized by TypeScript as a valid property in the instance.UI.loadDocument method.

Steps to reproduce

  1. Install @pdftron/webviewer version 10.7.1.
  2. Use the customHandlerId property in the instance.UI.loadDocument method in your code.
  3. TypeScript will show an error indicating that customHandlerId does not exist in the type definitions.

Possible Solution

Update the type definitions to include customHandlerId as a valid property in the instance.UI.loadDocument method.

Additional Context

I am using TypeScript version 4.9.5 and Node.js version 20.x.x on macOS.

My Environment

bollain commented 9 months ago

Hi @ToriaHUB,

Thanks for this report. I will add an item to our backlog to fix this doc. In the meantime, you can also use loadDocument from the documentViewer itself; looking at that code I see that customHandlerId is properly documented there. The UI method is just a wrapper for the method from the documentViewer.

Example:

const { documentViewer } = instance.Core;
documentViewer.loadDocument(....)