Add RenderContext in onRenderSuccess

Author: Bruceeeeeee

packages/react-pdf/src/Page/Canvas.spec.tsx

@@ -66,7 +66,14 @@ describe('Canvas', () => {
 
       expect.assertions(1);
 
-      await expect(onRenderSuccessPromise).resolves.toMatchObject([{}]);
+      await expect(onRenderSuccessPromise).resolves.toMatchObject([
+        {},
+        {
+          annotationMode: 1,
+          canvasContext: expect.any(Object),
+          viewport: page.getViewport({ scale: 1, rotation: 0 }),
+        },
+      ]);
 
       restoreConsole();
     });

packages/react-pdf/src/Page/Canvas.tsx

@@ -51,14 +51,14 @@ export default function Canvas(props: CanvasProps): React.ReactElement {
   /**
    * Called when a page is rendered successfully.
    */
-  function onRenderSuccess() {
+  function onRenderSuccess(renderContext: RenderParameters) {
     if (!page) {
       // Impossible, but TypeScript doesn't know that
       return;
     }
 
     if (onRenderSuccessProps) {
-      onRenderSuccessProps(makePageCallback(page, scale));
+      onRenderSuccessProps(makePageCallback(page, scale), renderContext);
     }
   }
 
@@ -126,7 +126,7 @@ export default function Canvas(props: CanvasProps): React.ReactElement {
         .then(() => {
           canvas.style.visibility = '';
 
-          onRenderSuccess();
+          onRenderSuccess(renderContext);
         })
         .catch(onRenderError);
 

packages/react-pdf/src/shared/types.ts

@@ -8,6 +8,7 @@ import type {
   TypedArray,
   DocumentInitParameters,
   RefProxy,
+  RenderParameters,
   StructTreeNode,
   TextContent,
   TextItem,
@@ -119,7 +120,7 @@ export type OnRenderAnnotationLayerSuccess = () => void;
 
 export type OnRenderError = OnError;
 
-export type OnRenderSuccess = (page: PageCallback) => void;
+export type OnRenderSuccess = (page: PageCallback, renderContext: RenderParameters) => void;
 
 export type OnRenderTextLayerError = OnError;