react-pdf
react-pdf copied to clipboard
wojtekmaj
Performance issues when rendering large PDFs
This might be a good question for pdf.js community itself but how does rendering large PDFs can be better handled with react-pdf?
pdf.js suggests not rendering more than 25 pages at a time: https://github.com/mozilla/pdf.js/wiki/Frequently-Asked-Questions#allthepages
I even had to add this to my component to keep react from trying re-create the virtual DOM of the Document:
shouldComponentUpdate(nextProps, nextState) {
if(nextProps.file !== this.props.file
|| nextState.numPages !== this.state.numPages
|| nextState.width !== this.state.width){
return true
}
return false
}
The problem is that I also need to dynamically set the width of the document on user interacting so I can't save myself from re-creating the virtual DOM after width changes, any way I can achieve this with your lib?
@jesusgp22 You probably want to use some kind of virtualization library for displaying PDF's with a lot of pages, like react-virtualized for instance. Maybe this is useful to you.
Hey, thank you so much for your answer, I'll def check this out
You might want to add a note about this on react-pdf documentation to help others with the same performance issues or even in the future add this as a core feature for large docs.
Following up on this @michaeldzjap I am watching some presentations on react-virtualized and it will break text search feature, is this a trade off that I can't get around?
I am not familiar with the text search feature I have to admit. But I suspect that it relies on the text layer for each page to be rendered in order to be able to find all the relevant results for a specific search query (e.g. a word that could be located anywhere in the document). The whole point of virtualizing a collection of elements (Page components in the case of react-pdf) is to not render them all at the same time.
I don't think there is an easy way around this unfortunately. A solution could be to keep a virtual representation of a text layer of each page in memory (like how React does this for HTML elements) and search through that instead. Might be possible.
That's an interesting approach, I am guessing this will most likely break browser text search feature anyway, in any case I think it is ok to implement this using just a regular search box element. Now the questions are:
- How can I extract the text from the pdf to keep a "virtual" copy of the whole text layer I can search from
- After getting a list of results from the text how can I implement a feature to seek these features in the document (guessing I will need to map results to scrollbar coordinates accordingly)
How can I extract the text from the pdf to keep a "virtual" copy of the whole text layer I can search from
I think you would need to dig into pdf.js for this, relying on the react-pdf api probably is not enough. You can get the text content for a page using this apparently:
page.getTextContent().then(function(textContent) { ... });
After getting a list of results from the text how can I implement a feature to seek these features in the document (guessing I will need to map results to scrollbar coordinates accordingly)
Yes, that is a tricky one... You'd know the page number. Maybe it should be a 2 step operation or something. 1 - Search through the virtual text layers for a query. Keep a result of all pages that match. 2 - For each page in the result of step 1 see if it is rendered, if it is you can probably find the word rather easily, because I think each word is rendered as a separate HTML element in a text layer. If the page is not rendered yet, scroll to it with react-virtualized so that it will be rendered and then again find the HTML element that contains the first occurrence of the word/query in the text layer element tree.
Something like the above. I might think too simplistic about this, I haven't actually tried it myself. But this is how I would approach things initially I think.
I was wondering if the biggest performance issue was rendering the text layer or the canvas, in case rendering the canvas is an issue, it might be possible to ask pdf.js to only render the text layer? I know this is not possible with the current react-pdf API
@jesusgp22 Nope, you can toggle text content and annotations on/off, but canvas is currently not behind a flag. I don't see a good reason against having it toggleable, though :)
I think you would need to dig into pdf.js for this, relying on the react-pdf api probably is not enough.
@michaeldzjap Any reason for this? Documents's onLoadSuccess should return all pdf properties and methods, and Page's onLoadSuccess should return all page properties and methods.
If you use Document, you can get the number of pages, iterate through all of them with pdf.getPage(pageNumber) and run the code you pasted on getPage()'s results.
@wojtekmaj Yes, my wording was rather poor. What I meant is that pdf.getPage(), page.getTextContent() etc. all are pdf.js related rather than react-pdf specific. So although of course all those methods are perfectly well accessible through the react-pdf API, they really belong to the underlying pdf.js API.
If you use Document, you can get the number of pages, iterate through all of them with pdf.getPage(pageNumber) ...
Yes. This is exactly what I do to cache all document page widths and height on initial load when using react-pdf together with react-virtualized.
We are also having trouble loading long PDFs. We are loading a 17mb PDFs and the application crashes, and since we have customers with 100mb+ PDFs, crashing is not an option.
This example which is also a react wrapper to PDF.js seem to work for us. It tricks PDF.js to load only the current visible page and the ten previous pages. It looks like it has something to do with the wrapper div's styles, because when you change some of the styles it loses it lazy loading behaviour.
I couldnt reproduce this trick to your lib. But we liked react-pdf so much that we are still trying to adapt this lazy load trick to it.
We like the fact that your lib has no default toolbox and that it has mapped its props to pdf.js handlers/configs, so we can develop our customized toolbox.
So we would be glad to see it working better with long pdfs, maybe using this trick that yurydelendik/pdfjs-react uses (thats a shame that I couldnt reproduce it with your lib! )
@MarcoNicolodi I found that react-virtualized worked really bad with react-pdf I implemented the aproach to only render a few pages but to make things work you have to render a div that has the dimensions of the pages you don't render
you can 100% integrate this with react-pdf using the document object that is returned by react-pdf and use getPage and page.getViewport methods to get the page dimensions
I built my own algorithm to detect what pages are visible and I run it everytime the user scrolls or if a resize event happens.
Hey everyone, I'd like to remind you that it was never React-PDF's intention to provide the users with fully-fledged PDF reader. Instead, this is only a tool to make it. While I have a plan of creating React-PDF-based PDF reader, I'm far from it. Mozilla is working on it for years and they seem to never be done. I think it would go similar way ;)
There is some good news too, though. If I can suggest something, onRenderSuccess callback that you can define for <Page> components can be your powerful friend. You can use it to, for example, force pages to be rendered one by one:
import React, { Component } from 'react';
import { Document, Page } from 'react-pdf/build/entry.webpack';
import './Sample.less';
export default class Sample extends Component {
state = {
file: './test.pdf',
numPages: null,
pagesRendered: null,
}
onDocumentLoadSuccess = ({ numPages }) =>
this.setState({
numPages,
pagesRendered: 0,
});
onRenderSuccess = () =>
this.setState(prevState => ({
pagesRendered: prevState.pagesRendered + 1,
}));
render() {
const { file, numPages, pagesRendered } = this.state;
/**
* The amount of pages we want to render now. Always 1 more than already rendered,
* no more than total amount of pages in the document.
*/
const pagesRenderedPlusOne = Math.min(pagesRendered + 1, numPages);
return (
<div className="Example">
<header>
<h1>react-pdf sample page</h1>
</header>
<div className="Example__container">
<div className="Example__container__document">
<Document
file={file}
onLoadSuccess={this.onDocumentLoadSuccess}
>
{
Array.from(
new Array(pagesRenderedPlusOne),
(el, index) => {
const isCurrentlyRendering = pagesRenderedPlusOne === index + 1;
const isLastPage = numPages === index + 1;
const needsCallbackToRenderNextPage = isCurrentlyRendering && !isLastPage;
return (
<Page
key={`page_${index + 1}`}
onRenderSuccess={
needsCallbackToRenderNextPage ? this.onRenderSuccess : null
}
pageNumber={index + 1}
/>
);
},
)
}
</Document>
</div>
</div>
</div>
);
}
}
Of course you can do much more - add placeholders, check on scroll which pages need rendering, keep info on whether all pages so far were rendered... I believe in your creativity ;) And if I can be of any help regarding API, please let me know!
@MarcoNicolodi yes, I think it can even be included as a PR to react-pdf at some point I don't have the time to share the code right now but I will later today.
I think the right place for that is Wiki. :) I highly encourage you to add your experiences on a new page there.
i've try to make react-pdf work with react-virtualized, but failed. it always print render cancel.
so i make a minimal demo with original pdf.js with react-virtualized, its pretty fast, weird.
https://github.com/crapthings/react-pdf-viewer/blob/master/client/pdf.js
@crapthings I think it may be something related to how react-virtualized measures rows before final rendering. It may unmount a component after initial measurement. I'm no expert in react-virtualized but perhaps you could force height or otherwise somehow disable these measurements? If something forces Page to unmount itself, it will cancel rendering. Should retry rendering on mounting again though 🤔
Well I want to contribute to the discussion because a project of mine depends on this awesome library and I found a way to implement lazy-loading with no extra dependencies. The only caveat is that I lost the natural scrolling behavior but the user can still scroll and change pages. The logic is that the visible component is just one page and there is another component with display='none' which renders more pages as needed. I needed an implementation where I could keep track programmatically of which page is visible right now, and with the "infinite" scrolling behavior it was a pain in the ass to implement. The customization is left to the developer (scroll threshold, how many more pages etc). Let me know what you think.
import React from 'react';
import { Document, Page } from 'react-pdf';
const pdfjs = require('pdfjs-dist/build/pdf.min.js');
pdfjs.PDFJS.workerSrc = '../src/assets/pdf.worker.min.js';
pdfjs.PDFJS.cMapUrl = '../src/assets/cmaps/';
pdfjs.PDFJS.cMapPacked = true;
export default class App extends React.Component {
constructor(props) {
super(props);
this.state = {
numPages: null,
pageIndex: null,
binaryPDFContent: somebase64string,
}
}
componentDidMount() {
this.PDFWidth = 400;
document.getElementById('pdfContainer').addEventListener('wheel', this.onScrollPDF.bind(this));
}
componentWillUnmount() {
document.getElementById('pdfContainer').removeEventListener('wheel', this.onScrollPDF.bind(this));
}
onDocumentLoadSuccess(nPages) {
if (this.state.pageIndex==null) {
this.setState({
numPages: nPages,
pageIndex: 0,
});
} else if (this.state.pageIndex > nPages) {
this.setState({
numPages: nPages,
pageIndex: nPages-1,
})
} else {
this.setState({
numPages: nPages,
});
}
}
onScrollPDF(event) {
let delta = null;
if (event.wheelDelta) {
delta = event.wheelDelta;
} else {
delta = -1 * event.deltaY;
}
// This is where some customization can happen
if (delta < -20) {
this.nextPage()
} else if (delta > 10) {
this.previousPage()
}
}
previousPage() {
if (this.state.pageIndex > 0) {
this.setState({
pageIndex: this.state.pageIndex-1
})
}
}
nextPage() {
if (this.state.pageIndex+1 < this.state.numPages) {
this.setState({
pageIndex: this.state.pageIndex+1
})
}
}
render() {
let PDFContainerHeight = 600;
return (
<div
id="pdfContainer"
style={{width:this.PDFWidth, height:PDFContainerHeight, overflow:'hidden'}}
>
<Document
file={{data:`data:application/pdf;base64,${this.state.binaryPDFContent}`}}
onLoadSuccess={(pdf) => {
this.onDocumentLoadSuccess(pdf.numPages)
}}
className="pdfPreview"
rotate={0}
>
<Page
key={`page_${this.state.pageIndex + 1}`}
width={this.PDFWidth}
pageNumber={this.state.pageIndex + 1}
className="pdfPage"
renderMode="svg"
/>
<FakePage
// This is where we can customize how many pages we need cached
pages={Math.min(this.state.numPages, this.state.pageIndex+20)}
width={this.PDFWidth}
/>
</Document>
</div>
)
}
}
class FakePage extends React.Component {
constructor(props) {
super(props)
}
render() {
return(
<div style={{display: 'none'}}>
{
Array.from(
new Array(this.props.pages),
(el, index) => (
<Page
key={`page_${index + 1}`}
width={this.props.width}
className="pdfPage"
renderMode="svg"
pageNumber={index + 1}
/>
),
)
}
</div>
)
}
}
That is pretty damn sweet! Does it work with React-PDF 2.x? I'd be genuinely surprised, think 3.0.0 would be the first version to handle all of that correctly!
I did not try it with 2. Lately I use your alpha release (which is awesome btw and I haven't got any errors yet). Still I could not find a way to make the infinite scrolling behavior and keep track of which page is visible. When I tried to apply this solution to your example I got pages with very big and variable gaps between them. I also could not trigger the caching of the next pages (since I could not get the visible page). I believe with a little time and patience a solution can be found that does not involve external libraries.
I tried it but did not get very far. I believe that it would give unnecessary overhead for my app and (for my specific use case) it still did not solve the problem of having programmatic access to which page is visible. tbh I did not spend much time on it as the fakepage trick struck me right after I installed the library :P If I find the time I will try to find the solution to the problem and close this issue once and for all.
@fetacore I initially went the custom route, but after a lot of trying different things out I settled on react-virtualized. That was quite a pain in the ass to get to play nicely with react-pdf, but I did manage to get it to work and it made things a hell of a lot easier in the end.
it still did not solve the problem of having programmatic access to which page is visible
That is definitely possible with react-virtualized. I needed this functionality in my app as well. You can use the onRowsRendered() function for that.
Hey, @fetacore @jesusgp22 @wojtekmaj and all friends of react-pdf! Has anyone gotten further on the subject? I really appreciate the discussion so far, and would love to hear your latest ideas, thanks!
@Lukars I've gotten react-pdf to play nicely with react-window (a newer and more compact version of react-virtualized).
I used the VariableSizeList which can window different page heights/widths.
On Document documentLoadSuccess, I call a function inherited from a parent component, setPageHeights, which caches all pageHeights (scaled dynamically to parent component height).
I then pass pageHeights as a prop to the child again, and there pass it into the itemSize prop of the VariableSizeList like itemSize={pageHeights[index]}.
When resizing or zooming in/out, I call the setPageHeights again with the updated scale and parent container, and use the VariableSizeList method resetAfterIndex(0) after updating pageHeights to clear and update the internally cached row heights in the VariableSizeList.
I also made a very small PureComponent for wrapping Page with a div wrapping it. This div then get's passed the styles from react-window. I think this part is pretty crucial for performance. On the built solution it looks pretty much 100% smooth even with scrolling very fast with 150 page + PDFs.
@nikonet care to post an example or a link to the file you are implement react-window with? Thanks!
I've had success with rendering with react-pdf together with react-window. The implementation below is inspired by the react-virtualized implementation by @michaeldzjap above and the description provided by @nikonet. It's still a work in progress but so far it seems to perform well. Any suggestions to improve the implementation would be greatly appreciated.
One thing that concerns me, however: By caching all page dimensions on document load I would assume that you would loose the ability of pdfjs to load pages in chunks with range requests. Any thoughts on this?
import React from 'react'
import PropTypes from 'prop-types'
import { debounce } from 'lodash'
import { VariableSizeList as List } from 'react-window'
import { Document } from 'react-pdf/dist/entry.webpack'
import PageRenderer from './PageRenderer'
import PlaceholderPageList from './PlaceholderPageList'
import { PAGE_SPAZING } from './../constants'
/* eslint-disable import/no-webpack-loader-syntax */
import testpdf from 'url-loader!./../testpdf.pdf'
import './../style.scss'
const file = {
url: testpdf
}
const propTypes = {
scale: PropTypes.number.isRequired
}
// PDFjs options
const options = {}
class DocumentViewer extends React.Component {
static propTypes = propTypes
constructor (props) {
super(props)
this.state = {
containerWidth: undefined,
containerHeight: undefined,
numPages: undefined,
currentPage: 1,
cachedPageDimensions: null
}
this.viewerContainerRef = React.createRef()
this.listRef = React.createRef()
}
componentDidMount () {
this._mounted = true
this.calculateContainerBounds()
window.addEventListener('resize', this.handleWindowResize, true)
}
componentWillUnmount () {
this._mounted = false
window.removeEventListener('resize', this.handleWindowResize, true)
}
componentDidUpdate (prevProps) {
if (prevProps.scale !== this.props.scale) {
this.recomputeRowHeights()
}
}
/**
* Load all pages to cache all page dimensions.
*/
cachePageDimensions (pdf) {
const promises = Array.from({ length: pdf.numPages }, (v, i) => i + 1).map(
pageNumber => pdf.getPage(pageNumber)
)
// Assuming all pages may have different heights. Otherwise we can just
// load the first page and use its height for determining all the row
// heights.
Promise.all(promises).then(values => {
if (!this._mounted) {
return null
}
const pageDimensions = values.reduce((accPageDimensions, page) => {
accPageDimensions.set(page.pageIndex + 1, [
page.view[2],
page.view[3] + PAGE_SPAZING
])
return accPageDimensions
}, new Map())
this.setState({
cachedPageDimensions: pageDimensions
})
})
}
calculateContainerBounds = () => {
if (this.viewerContainerRef == null) {
return
}
const rect = this.viewerContainerRef.current.getBoundingClientRect()
this.setState({
containerWidth: rect.width,
containerHeight: rect.height
})
}
recomputeRowHeights = () => {
this.listRef.current.resetAfterIndex(0)
}
/*
HANDLERS
*/
onDocumentLoadSuccess = pdf => {
this.setState({
numPages: pdf.numPages
})
this.cachePageDimensions(pdf)
this.calculateContainerBounds()
}
handleWindowResize = debounce(() => {
this.calculateContainerBounds()
}, 300)
updateCurrentVisiblePage = ({ visibleStopIndex }) => {
this.setState({
currentPage: visibleStopIndex + 1
})
}
/*
GETTERS
*/
getItemSize = index => {
return this.state.cachedPageDimensions.get(index + 1)[1] * this.props.scale
}
/*
RENDERERS
*/
render () {
const {
numPages,
cachedPageDimensions,
containerHeight
} = this.state
const itemData = {
scale: this.props.scale,
cachedPageDimensions: cachedPageDimensions
}
return (
<div className='dv' ref={this.viewerContainerRef}>
<Document
className='dv__document'
file={file}
onLoadSuccess={this.onDocumentLoadSuccess}
options={options}
loading={<PlaceholderPageList />}
>
{cachedPageDimensions != null && (
<List
height={containerHeight}
itemCount={numPages}
itemSize={this.getItemSize}
itemData={itemData}
overscanCount={2}
onItemsRendered={this.updateCurrentVisiblePage}
ref={this.listRef}
>
{PageRenderer}
</List>
)}
</Document>
</div>
)
}
}
export default DocumentViewer
//////////////////////////////////////////////////
import React from 'react'
import PropTypes from 'prop-types'
import { Page } from 'react-pdf/dist/entry.webpack'
const propTypes = {
index: PropTypes.number.isRequired,
style: PropTypes.object.isRequired,
data: PropTypes.object.isRequired
}
export default class PageRenderer extends React.PureComponent {
static propTypes = propTypes
render () {
const { index, data } = this.props
const { cachedPageDimensions, scale } = data
const pageNumber = index + 1
const pageDimensions = cachedPageDimensions.get(pageNumber)
const width = pageDimensions[0] * scale
const style = {
...this.props.style,
width,
left: '50%',
WebkitTransform: 'translateX(-50%)',
transform: 'translateX(-50%)'
}
return (
<div
className='dv__page-wrapper'
key={`page_${pageNumber}`}
style={style}
>
<Page
className='dv__page'
pageNumber={pageNumber}
scale={scale}
renderAnnotationLayer={false}
/>
</div>
)
}
}
Amazing. I ended up getting it working, but noticed some room for improvement on mine after viewing yours. I appreciate you sharing.