Add prop for custom text rendering

[juliakieserman]

Added optional prop customTextRenderer that allows user to pass in a function that will modify how text div is rendered within text layer. Possible use case includes the ability to highlight words.

(potentially addresses #160 as well)

[juliakieserman]

hey @wojtekmaj! just want to add a little more context here - essentially I have implemented a search function (using js-worker-search) and want to use this added code as a way to indicate to the renderer which text items should be highlighted to indicate they match. So essentially I would implement a function to pass to customTextRenderer that would pass an element that has a <mark> wrapped around the text if it came back as a match. There are a lot of different possible ways to use this (crossed out text, bold text, etc.), as I tried to keep it as general as possible, but this is the use case I'm planning on using it for.

[wojtekmaj]

Thanks for all the information! I'm busy at the moment, but quickly approaching the moment in which I'll be able to focus on open source stuff :) I'll review it today!

[wojtekmaj]

Sweet! Thank you :)

[wojtekmaj]

Played with it a little bit... This is really super cool 😀

[juliakieserman]

awesome! glad you like it :). Very cool library.

[juliakieserman]

hey @wojtekmaj when do you expect to next release?

[wojtekmaj]

@juliakieserman, I'm preparing to release v3.0.0 sometime this month. The first feature complete beta was just released. I'm monitoring the opinions in #143 and if nothing super horrible appears after a short while of beta program, I think we'll be ready to go :)

[juliakieserman]

got it, thanks! also @wojtekmaj - it looks like you made some changes that removed the index being passed back along with the text layer props...would you mind putting that back in? This allows a custom renderer function to do a check on an index in the text layer to decide what to do with it.

[wojtekmaj]

Missed that during refactoring. Adding the fix + tests to prevent that in the future right away.

[wojtekmaj]

3.0.1 is out! Sorry!

[juliakieserman]

thanks for the quick response! looks like itemIndex is still coming back as undefined though...

[juliakieserman]

ah - nevermind, I see you grouped it with the rest of the content. Thanks!

[juliakieserman]

hey @wojtekmaj - sorry to keep bugging you with this, but I'm starting to wonder if passing back a page index would also be super helpful. That way you could say things like "for page 4, I want to edit the 8th index in the text content". Any chance we could throw that in there?

[wojtekmaj]

There will be no passing back like this for sure as this breaks the nice flow React makes. But!

<Document file={...} >
  <Page
    pageNumber={pageNumber}
    customTextRenderer={({ str, itemIndex }) =>
      (
        pageIndex === 4 && itemIndex === 8
          ? 'I am 8th string on page 4'
          : str
        )
      }
  />
</Document>