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

PdfViewState

class PdfViewState(val document: <Error class: unknown class>, 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: <Error class: unknown class>, 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: <Error class: unknown class>

isZoomed

val isZoomed: Boolean

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

pageCount

val pageCount: Int

panOffset

var panOffset: Offset

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

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.

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.