README.md

Materialize

Simple PDF viewer made with and for Jetpack Compose

Requirements

[OPTIONAL] Add INTERNET permission to your Android Manifest if you intend to retrive PDF documents via URLs

<uses-permission android:name="android.permission.INTERNET" />

[OPTIONAL] Set android:usesCleartextTraffic="true" in your Android Manifest <application> tag to enable downloading of PDF documents from unsecure http:// URLs

<application>
  ...
  android:usesCleartextTraffic="true"
  ...
</application>

Add materialize to your project dependencies

dependencies {
  implementation("io.github.arcanegolem:materialize:<version>")
}

Example usage

ColumnPdfViewer composable function provides a simple scrollable column PDF viewer, fillers and "more" menu can be customized using PdfViewerColors and options parameters. PDF document can be provided via URL, Uri or Raw resource using corresponding PdfProvider.

For example, following code (see more in MainActivity.kt) will result in something like this:

ColumnPdfViewer(
  modifier = Modifier.fillMaxSize(),
  pdfProvider = PdfProvider.ResProvider(
    resId = R.raw.sample_multipage,
    bitmapScale = 3,
    identifier = "sample_multipage"
  ),
  colors = PdfViewerColors(
    fillerPageColor = Color.Black,
    floatingElementsColor = Color.Blue,
    iconButtonColors = IconButtonDefaults.iconButtonColors(),
    textFieldColors = TextFieldDefaults.colors()
  ),
  options = listOf(
    PdfViewerOption(
      title = "SampleOption",
      action = {
        Toast.makeText(context, "Sample text", Toast.LENGTH_SHORT).show()
      }
    ),
    PdfViewerOption(
      title = "SampleOption2",
      action = {
        Toast.makeText(context, "Another sample text", Toast.LENGTH_SHORT).show()
      }
    )
  ),
  fillerAspectRatio = 1f / sqrt(2f)
)