Package com.pspdfkit.jetpack.compose

Types

A state object that can be hoisted to control and observe properties of the DocumentView. Create instances of this object using rememberDocumentState.

ExperimentalPSPDFKitApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION] )

annotation class ExperimentalPSPDFKitApi

Annotation used to indicate a member is part of an experimental PSPDFKit API. Anything carrying this annotation may be changed in the future without notice.

Functions

DocumentView

@Composable

fun DocumentView(documentUri: Uri, modifier: Modifier = Modifier)

@Composable

fun DocumentView(documentState: DocumentState, modifier: Modifier = Modifier)

Composable that displays the Document in the specified Uri.

ImageDocumentView

@Composable

fun ImageDocumentView(imageUri: Uri, modifier: Modifier = Modifier)

Composable that displays the Image in the specified Uri.

@Composable

fun ImageDocumentView(documentState: DocumentState, modifier: Modifier = Modifier)

Composable that displays the Document in the specified Uri.

rememberDocumentState

@Composable

fun rememberDocumentState(documentUri: Uri, configuration: PdfActivityConfiguration = PdfActivityConfiguration.Builder(LocalContext.current).build(), @IntRange(from = 0) startingPage: Int = 0): DocumentState

A state object that can be hoisted to control and observe properties of the DocumentView. Returns a Saveable containing the DocumentState, used for remembering the state of a given document.