v6.0.0

See Upgrade guide from version 5.x to 6.x.

Note: React <16.8 is not supported. If you're still using React older than 16.8, please use react-pdf@^5.0.0 instead.

❗️ = breaking change

What's new?

• ❗️ Vastly improved performance and bundle size thanks to the modern version of PDF.js that is now used. This drops support for legacy browsers. See README for details.
• Added official support for Vite.
• Updated PDF.js to 2.16.105 (#1019).
  • Improvements for the text layer (space insertion)
  • Improvements for canvas rendering (thin line rendering)
  • Improvements for forms (printing/saving of choice lists)
  • Improvements for accessibility (sidebar and search results)
  • Bug fixes and optimizations, in particular for annotations, font/image conversion, SMask rendering, text layer rendering and TypeScript definitions
  • Performance improvements for rendering image masks, Type3 fonts and certain drawing instructions
  • Support for specifying custom background/foreground colors for rendering in the viewer (this will be soon be supported in React-PDF)
  • Bugfixes
  • Accessibility improvements
  • Rendering quality improvements.
• Improved documentation.
  • Fixed instructions on PDF.js worker
  • Added missing documentation on onRenderTextLayerError and onRenderTextLayerSuccess
  • Added a note on SVG mode deprecation.
• Refactored TextLayer to use pdfjs.renderTextLayer (#944).
  • Added support for onRenderTextLayerError prop
  • Added support for onRenderTextLayerSuccess prop.
• React-PDF now warns if required CSS files are not imported.

What's changed?

• ❗️ Minimum React version is now 16.8.
• ❗️ onGetTextSuccess is now called with an object containing items and styles.
• ❗️ TextLayer.css now must be imported manually for TextLayer to work properly.
• ❗️ Dropped support for React content in customTextRenderer (#1124).
• file-loader is now an optional peerDependency (#970). Thanks, @rpaasche!
• Improved documentation on Preact compatibility.
• Replaced merge-class-names with clsx.

Bug fixes

• Fixed crash when attempting to cancel rendering of PageCanvas.
• Fixed crash when text layer in PDFs rendered by React-PDF was used in Preact applications.
• Fixed legacy renderInteractiveForms prop ignored. Thanks, @liquidautumn!
• Fixed Page wrapper allowing to shrink causing children to overflow (#1118).