kitepdf-compose-viewer/io.github.yuroyami.kitepdf.compose/PdfViewState

PdfViewState

class PdfViewState(val document: KiteDocument, initialPage: Int = 0)

Observable state + control surface of a PdfView.

Everything a navigation/zoom widget needs lives here, so widgets are just composables that take a PdfViewState. Place them inside the viewport (via PdfView's overlay slot), next to it, or anywhere else in your tree.

Reads (currentPage, zoom, panOffset…) are snapshot-state backed and recompose their readers automatically. Navigation suspends until finished; calls made before the state is attached to a composed PdfView are remembered and applied on attach.

Constructors

PdfViewState

constructor(document: KiteDocument, initialPage: Int = 0)

Properties

currentPage

val currentPage: Int

The page the viewport currently rests on: the snapped page in paged mode, the page nearest the viewport centre in continuous mode.

document

val document: KiteDocument

highlights

var highlights: List<PdfHighlight>

App-owned highlights, each with its own fill colour and its own optional margin marker. Painted over the page after searchHighlights, in list order, so later entries win where they overlap. Clear by assigning an empty list.

isSelectionActive

var isSelectionActive: Boolean

True while text selection owns the pointer, and while the selection it produced is still on screen.

isZoomed

val isZoomed: Boolean

True once zoomed in beyond the minimum (with a small epsilon).

onSelectionChange

var onSelectionChange: (TextSelection?) -> Unit?

Fires on every selection change, including clearing (null).

pageCount

val pageCount: Int

panOffset

var panOffset: Offset

Pan translation in viewport px, applied after zoom around the viewport centre.

searchHighlights

var searchHighlights: List<KiteSearchHit>

Search hits to paint as translucent quads over their pages (colour: PdfViewColors.searchHighlight). Feed it from PdfDocument.search / KiteStructuredText.search (quads are display-space, as both produce); clear it by assigning an empty list.

selection

var selection: TextSelection?

The active text selection, or null. Set by the long-press-drag gesture; observe via snapshot reads or onSelectionChange. The viewer never touches the clipboard itself. Read TextSelection.text and copy in the app (see the sample's selection actions).

selectionInProgress

var selectionInProgress: Boolean

True only while the finger is still down on the long-press drag that is building the selection; false the moment it lifts.

zoom

var zoom: Float

Current zoom factor. 1 = fit. Bounded by PdfZoomSpec.minZoom/maxZoom.

Functions

animateScrollToPage

suspend fun animateScrollToPage(page: Int)

Animates to page (coerced into range).

animateZoomTo

suspend fun animateZoomTo(target: Float, focal: Offset = Offset.Unspecified, animationSpec: AnimationSpec<Float> = spring())

Animates zoom to target (clamped), keeping focal stationary throughout.

clearSelection

fun clearSelection()

hitTest

fun hitTest(viewportOffset: Offset): PageHit?

Maps a viewport point (the space gesture callbacks like onTap report in) to the page under it, or null when it lands on background/spacing.

suspend fun nextPage()

panBy

fun panBy(delta: Offset): Offset

Pans by delta (viewport px), clamped to the zoomed content bounds. Returns the portion actually consumed. The gesture layer hands the remainder back to the underlying scroll container.

suspend fun previousPage()

resetZoom

fun resetZoom()

Snaps back to the minimum zoom and recentres.

scrollToPage

suspend fun scrollToPage(page: Int)

Jumps to page (coerced into range) without animation.

setZoom

fun setZoom(zoom: Float, focal: Offset = Offset.Unspecified)

Sets zoom immediately, clamped to the active PdfZoomSpec range.