Introduction

React Reader is a package that offers a plug&play reader interface for your React project that works seamlessly with prose. The intent is to have a drop in reader that you can use as is or customize to suit your app need.

You can see it in action in our demo.

It us using https://www.chakra-ui.com/ under the hook for its theme to offer good range of customization.

Some considerations

This package is not vanilla JS and will require a few peer dependencies. As a result it may increase your app size and you may want to check if you are okay with this. Although we try to stay as close to vanilla as possible, the biggest library is https://www.chakra-ui.com/. If you don't use it, don't worry it will be scoped to the reader and will not interfere with your app design.

Visit https://github.com/mbret/prose-reader/blob/master/packages/react-reader/package.json to check the peer dependencies required.

Customization will be possible to some extends (for example by customizing the same way as you would with the chakra theme) but not all UX elements will necessary match your specific design. This package is not a UX component library but rather a ready to use reader. It's a tradeoff for your team in order to offload the maintenance of the reader.

It is currently under development