OverflowableNavigator

A VisualNavigator with content that can extend beyond the viewport.

The user typically navigates through the publication by scrolling or tapping the viewport edges.

Types

interface Overflow

abstract val currentLocator: StateFlow<Locator>

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

Current presentation rendered by the navigator.

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.

abstract fun goBackward(animated: Boolean = false): Boolean

Moves to the previous content portion (eg. page) in the reading progression direction.

abstract fun goForward(animated: Boolean = false): Boolean

Moves to the next content portion (eg. page) in the reading progression direction.

Removes a previously registered InputListener.