Getting Started

Installation

npm install @prose-reader/core @prose-reader/react-reader @chakra-ui/react @emotion/react rc-slider react-icons reactjrx

This package only uses peerDependencies so don't hesitate to use the library for the rest of your app.

https://github.com/mbret/reactjrx is specifically very useful if you use rxjs.

Configuration

_todo

Toggling features

By default, the reader will use the bare core reader. If you want to unlock more features you can enhance your reader with automatically supported enhancers.

For example adding the enhancer Search will unlock this menu:

import { searchEnhancer } from "@prose-reader/enhancer-search"
import { createReader } from "@prose-reader/core"

export const createAppReader = searchEnhancer(createReader)

See Search to install enhancer

Bookmarks

See Annotations to install enhancer

  • Bookmarking a page is done by taping the top right corner the page.

Annotations

See Annotations to install enhancer

See Galleryto install enhancer

Last updated

Was this helpful?