readium-navigator/org.readium.r2.navigator/HyperlinkNavigator

HyperlinkNavigator

interface HyperlinkNavigator : Navigator

A navigator supporting hyperlinks.

Inheritors

EpubNavigatorFragment

Types

FootnoteContext

data class FootnoteContext(val noteContent: String) : HyperlinkNavigator.LinkContext

sealed interface LinkContext

interface Listener : Navigator.Listener

Properties

abstract val currentLocator: StateFlow<Locator>

Current position in the publication. Can be used to save a bookmark to the current position.

Functions

abstract fun go(link: Link, animated: Boolean = false): Boolean

Moves to the position in the publication targeted by the given link.

abstract fun go(locator: Locator, animated: Boolean = false): Boolean

Moves to the position in the publication corresponding to the given Locator.