API reference

Components

Name	Description
ReadiumView	Renders a publication: an EPUB or PDF on iOS and Android, or a web publication on web.
ReadiumViewRef	Moves the reader, searches and zooms; get it with a ref on ReadiumView.
ReadiumProps	The props of ReadiumView.

Hooks

Name	Description
UseSearchResult	What useSearch returns: the accumulated results, their state, and the actions.
useSearch	Drives paginated full-text search for a ReadiumView.

Functions

Function	Description
describePublicationError	The default English description of a PublicationErrorCode, as message reports it.

Interfaces

Interface	Description
Dimensions	-
Link	An interface representing the Readium Link object. Extends the Nitro spec Link with an optional properties bag and supports hierarchical TOC via nested children.
Preferences	Preferences with refined string union types for better IDE autocompletion.
PublicationErrorEvent	The publication could not be opened. url, code and protectionScheme are as native reports them; message and detail are described below.
PublicationMetadata	Publication metadata following Readium Web Publication Manifest spec. Extends the Nitro spec metadata with the @type field.
PublicationReadyEvent	-
ZoomEvent	Reports the reader's magnification, including changes the reader makes with a pinch or a double tap rather than through setZoom.
LocatorLocations	Where in its resource a Locator points.
LocatorText	Text around a location, e.g. a search match in context.
Locator	A location in a publication, as Readium describes it: reading positions, bookmarks, highlights and search results are all locators. Store them as they are to reopen there later.
DecorationStyle	How a decoration looks.
Decoration	One annotation rendered over the publication, such as a highlight.
DecorationGroup	A named set of decorations, such as "highlights".
Rect	-
Point	-
SelectionAction	An item added to the text-selection menu.
Contributor	-
Subject	-
SeriesInfo	-
BelongsTo	-
AccessibilityCertification	-
Accessibility	-
SearchOptions	-
SearchResult	-
SearchPage	A single page of search results, returned by search() and loadMoreSearchResults(). Results are paginated lazily: keep calling loadMoreSearchResults() while hasMore is true.
PreferencesChangedEvent	Reported by onPreferencesChanged once preferences are applied.
DecorationActivatedEvent	Reported by onDecorationActivated when the user taps a decoration.
SelectionEvent	Reported by onSelectionChange as the user adjusts a selection.
SelectionActionEvent	Reported by onSelectionAction when the user picks one of the selectionActions.
ReadiumFile	The publication a ReadiumView opens.

References

File

Renames and re-exports ReadiumFile

Type Aliases

Type Alias	Description
DecorationGroups	-
Capabilities	Something the reader can do with the publication it opened.
PublicationErrorCode	Why a publication could not be opened. - protectionNotSupported: protected with a scheme no registered content protection handles. - restricted: a protection matched but refused access, e.g. an expired license. - cancelled: restricted with no error, e.g. the passphrase prompt was dismissed.

Variables

Variable	Description
RANGES	The range of each numeric preference, as [min, max], e.g. for a slider.