VisualNavigator

A navigator rendering the publication visually on-screen.

Types

abstract val currentLocator: StateFlow<Locator>

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

View displaying the publication.

Adds a new InputListener to receive touch, mouse or keyboard events.

Returns the Locator to the first content element that begins on the current screen.

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.

Removes a previously registered InputListener.