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

Prose settings vs Reader settings

Some settings are managed by the reader (eg: font size), as a result you should not specify them during the creation of your prose instance or they will be overwritten. Check the properties from the reader component to see what is available. Usually when the reader can change a setting of prose or its enhancers it setting should be managed through it. This is to avoid having multiple source of truth.

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)

We are detecting certain markers in the enhancers to verify whether they exist and are valid. This is assuming you dont fiddle with them. The general rule of enhancers is to allow augmentation but not alteration.

Search

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

Gallery

See Galleryto install enhancer

Refit

See Refitto install enhancer