readium-navigator/org.readium.r2.navigator/SelectableNavigator

SelectableNavigator

interface SelectableNavigator : Navigator

A navigator supporting user selection.

Inheritors

Properties

Link copied to clipboard
abstract val currentLocator: StateFlow<Locator>

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

Functions

Link copied to clipboard
abstract fun clearSelection()

Clears the current selection.

Link copied to clipboard
abstract suspend fun currentSelection(): Selection?

Currently selected content.

Link copied to clipboard
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.

Generated by Dokka
© 2026 Copyright