https://github.com/Dmitry-Borodin/pdfview-android

Small Android library to show PDF files
https://github.com/Dmitry-Borodin/pdfview-android

android android-pdf android-pdfviewer hacktoberfest library pdf pdf-viewer

Last synced: about 1 month ago
JSON representation

Small Android library to show PDF files

• Host: GitHub
• URL: https://github.com/Dmitry-Borodin/pdfview-android
• Owner: Dmitry-Borodin
• License: apache-2.0
• Created: 2019-01-26T16:51:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-13T13:07:44.000Z (over 2 years ago)
• Last Synced: 2024-10-01T07:24:39.680Z (2 months ago)
• Topics: android, android-pdf, android-pdfviewer, hacktoberfest, library, pdf, pdf-viewer
• Language: Java
• Homepage:
• Size: 5.27 MB
• Stars: 294
• Watchers: 13
• Forks: 48
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-Android-Open-Source-Projects - Pdfview-Android

README

        
# pdfview

[![Build Status](https://app.bitrise.io/app/40d453ac50882d9c/status.svg?token=BfV89EoWjOEfvATradLDOw&branch=dev)](https://app.bitrise.io/app/40d453ac50882d9c)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.dmitryborodin/pdfview-android/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/com.dmitryborodin/pdfview-android)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Android Arsenal]( https://img.shields.io/badge/Android%20Arsenal-PdfView--Android-green.svg?style=flat )]( https://android-arsenal.com/details/1/7820 )

Android PDF view - small (73kB .aar file, ~400 methods before minification) and efficient PDF viewer embedded in your native app

It is based on ImageView and can handle big files with reasonable scrolling and zooming performance. 

This is how fast scrolling of 680 page document looks like on low-end device:

![Example1](gifs/fast_scrolling_on_weak_device.gif)

## Usage:

To show pdf you just need a file on the device.

```

findViewById(R.id.activityMainPdfView).fromAsset("paper.pdf").show()

```

See [sources](/pdfview-android/src/main/java/com/pdfview/PDFView.kt) for other methods to provide a file.

If pdf is on remote host - use your network client to download it to the cache folder, then show it. This library provides view, it doesn't do network requests.

There is a [sample](/sample-network) of how to do it.

## Add to your project:

The library is hosted in the central repository.

```

     repositories {

        <...>

        mavenCentral()

    }

```

Add gradle dependency:

```

implementation "com.dmitryborodin:pdfview-android:1.1.0"

```

## Wiki

Please take a look into [the wiki](/../../wiki) to find out the technical details.

## Contrubitions

Contributions are welcome. 

Just open PR to dev branch.

Feel free to open issue with any questions.

## Credits

Thanks to [Manuel Lilienberg](https://github.com/mlilienberg) for initial implementation of this library and [subsampling-scale library](https://github.com/davemorrissey/subsampling-scale-image-view) for influence.