{"id":13604816,"url":"https://github.com/voghDev/PdfViewPager","last_synced_at":"2025-04-12T02:31:43.954Z","repository":{"id":42226222,"uuid":"51458005","full_name":"voghDev/PdfViewPager","owner":"voghDev","description":"Android widget that can render PDF documents stored on SD card, linked as assets, or downloaded from a remote URL.","archived":false,"fork":false,"pushed_at":"2021-09-14T17:00:12.000Z","size":15546,"stargazers_count":1695,"open_issues_count":45,"forks_count":331,"subscribers_count":64,"default_branch":"master","last_synced_at":"2024-10-31T02:08:08.550Z","etag":null,"topics":["android","espresso","library","pdf","pdf-book","pdf-document","rendering","testing","ui","ui-automated-tests"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voghDev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-10T17:30:23.000Z","updated_at":"2024-10-29T07:18:20.000Z","dependencies_parsed_at":"2022-08-12T09:51:09.634Z","dependency_job_id":null,"html_url":"https://github.com/voghDev/PdfViewPager","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voghDev%2FPdfViewPager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voghDev%2FPdfViewPager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voghDev%2FPdfViewPager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voghDev%2FPdfViewPager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voghDev","download_url":"https://codeload.github.com/voghDev/PdfViewPager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223489665,"owners_count":17153798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","espresso","library","pdf","pdf-book","pdf-document","rendering","testing","ui","ui-automated-tests"],"created_at":"2024-08-01T19:00:51.573Z","updated_at":"2024-11-07T09:31:01.392Z","avatar_url":"https://github.com/voghDev.png","language":"Java","readme":"# PdfViewPager\n\n[![Download](https://api.bintray.com/packages/voghdev/maven/pdfviewpager/images/download.svg) ](https://bintray.com/voghdev/maven/pdfviewpager/_latestVersion)\n[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-PdfViewPager-green.svg?style=true)](https://android-arsenal.com/details/1/3155)\n[![Build Status](https://travis-ci.org/voghDev/PdfViewPager.svg?branch=master)](https://travis-ci.org/voghDev/PdfViewPager)\n\nAndroid widget to display PDF documents in your Activities or Fragments.\n\nImportant note: **PDFViewPager** uses [PdfRenderer][6] class, which works **only on API 21 or higher**.\nSee [Official doc][6] for details.\n\nIf you are targeting pre-Lollipop devices, have a look at the [legacy sample][7]\n\nInstallation\n------------\n\nAdd this line in your *app/build.gradle*\n\n    implementation 'es.voghdev.pdfviewpager:library:1.1.2'\n\nIf you want to use the old `android.support` instead of `androidx`, add this dependency\n\n    implementation 'es.voghdev.pdfviewpager:library:1.0.6'\n\nUsage\n-----\n\nUse **PDFViewPager** class to load PDF files from assets or SD card\n\n![Screenshot][localPDFScreenshot] ![Screenshot][zoomingScreenshot]\n\n1.- Copy your assets to cache directory if your PDF is located on assets directory\n\n    CopyAsset copyAsset = new CopyAssetThreadImpl(context, new Handler());\n    copyAsset.copy(asset, new File(getCacheDir(), \"sample.pdf\").getAbsolutePath());\n\n2a.- Create your **PDFViewPager** passing your PDF file, located in *assets* (see [sample][8])\n\n    pdfViewPager = new PDFViewPager(this, \"sample.pdf\");\n\n2b.- Or directly, declare it on your XML layout\n\n    \u003ces.voghdev.pdfviewpager.library.PDFViewPager\n        android:id=\"@+id/pdfViewPager\"\n        android:layout_width=\"match_parent\"\n        android:layout_height=\"match_parent\"\n        app:assetFileName=\"sample.pdf\"/\u003e\n\nIt will automatically have zooming and panning capability\n\n3.- Release adapter in *onDestroy*\n\n    @Override\n    protected void onDestroy() {\n        super.onDestroy();\n\n        ((PDFPagerAdapter) pdfViewPager.getAdapter()).close();\n    }\n\nPDF's on SD card\n----------------\n\n1.- Create a **PDFViewPager** object, passing the file location in your SD card\n\n    PDFViewPager pdfViewPager = new PDFViewPager(context, getPdfPathOnSDCard());\n\n    protected String getPdfPathOnSDCard() {\n        File f = new File(getExternalFilesDir(\"pdf\"), \"adobe.pdf\");\n        return f.getAbsolutePath();\n    }\n\n2.- Don't forget to release the adapter in *onDestroy*\n\n        @Override\n        protected void onDestroy() {\n            super.onDestroy();\n\n            ((PDFPagerAdapter) pdfViewPager.getAdapter()).close();\n        }\n\nRemote PDF's from a URL\n-----------------------\n\n![Screenshot][remotePDFScreenshot]\n\n1.- Add `INTERNET`, `READ_EXTERNAL_STORAGE` and `WRITE_EXTERNAL_STORAGE` permissions on your AndroidManifest.xml\n\n    \u003cuses-permission android:name=\"android.permission.INTERNET\" /\u003e\n    \u003cuses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\" /\u003e\n    \u003cuses-permission android:name=\"android.permission.READ_EXTERNAL_STORAGE\" /\u003e\n\n2.- Make your Activity or Fragment implement DownloadFile.Listener\n\n    public class RemotePDFActivity extends AppCompatActivity implements DownloadFile.Listener {\n\n3.- Create a **RemotePDFViewPager** object\n\n    String url = \"http://www.cals.uidaho.edu/edComm/curricula/CustRel_curriculum/content/sample.pdf\";\n    \n    RemotePDFViewPager remotePDFViewPager =\n          new RemotePDFViewPager(context, url, this);\n\n4.- Configure the corresponding callbacks and they will be called on each situation.\n\n    @Override\n    public void onSuccess(String url, String destinationPath) {\n        // That's the positive case. PDF Download went fine\n\n        adapter = new PDFPagerAdapter(this, \"AdobeXMLFormsSamples.pdf\");\n        remotePDFViewPager.setAdapter(adapter);\n        setContentView(remotePDFViewPager);\n    }\n\n    @Override\n    public void onFailure(Exception e) {\n        // This will be called if download fails\n    }\n\n    @Override\n    public void onProgressUpdate(int progress, int total) {\n        // You will get download progress here\n        // Always on UI Thread so feel free to update your views here\n    }\n\n5.- Don't forget to close adapter in *onDestroy* to release all resources\n\n    @Override\n    protected void onDestroy() {\n        super.onDestroy();\n\n        adapter.close();\n    }\n\nUsage in Kotlin\n---------------\n\nAs you might figure out, the library is fully usable in Kotlin programming language. You can find example code [here][12].\n\nJust import the library as a gradle dependency as you would do in Java.\n\nTODOs\n-----\n\n- [X] Make initial Pdf scale setable by code *(requested by various users on issues)*\n- [X] Load PDF documents from SD card\n- [X] Make PDF documents zoomable with pinch and double tap (two approaches, [ImageViewZoom][5] and [photoview][11])\n- [X] Unify all features in only one **PDFViewPager** and **PDFPagerAdapter** class\n- [X] Support API Levels under 21, by downloading PDF and invoking system native intent.\n- [X] UI tests\n- [X] Add checkstyle, refactor \u0026 improve code quality\n\nSee [changelog][4] for details\n\nDeveloped By\n------------\n\n* Olmo Gallegos Hernández - [voghDev][9] - [mobiledevstories.com][10]\n\n\u003ca href=\"http://twitter.com/voghDev\"\u003e\n  \u003cimg alt=\"Follow me on Twitter\" src=\"https://image.freepik.com/iconos-gratis/twitter-logo_318-40209.jpg\" height=\"60\" width=\"60\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://www.linkedin.com/profile/view?id=91543271\"\u003e\n  \u003cimg alt=\"Find me on Linkedin\" src=\"https://image.freepik.com/iconos-gratis/boton-del-logotipo-linkedin_318-84979.png\" height=\"60\" width=\"60\" /\u003e\n\u003c/a\u003e\n\nSupport\n-------\n\nThis repository has been supported by JetBrains with free licenses for all JetBrains products\n\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/JetBrains_Logo_2016.svg/1200px-JetBrains_Logo_2016.svg.png\" width=\"250\" /\u003e\n\n# License\n\n    Copyright 2016 Olmo Gallegos Hernández\n\n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n\nContributing\n------------\n\n**For noobs (like me some months ago)**\n\n    fork the project into your GitHub account\n    now clone your GitHub repo for this project\n    implement your changes\n    commit your changes, push them into your repo\n    review your code and send me a pull request if you consider it\n\n**For not-so-noobs**\n\nPlease make sure that your changes pass both checkstyle and UI tests before submitting them\n\n    ./gradlew checkstyle\n\n    ./gradlew test\n\nAnd with your Android device connected\n\n    ./gradlew connectedCheck\n\n[remotePDFScreenshot]: ./screenshots/remote.gif\n[localPDFScreenshot]: ./screenshots/local.gif\n[sdcardPDFScreenshot]: ./screenshots/sdcard.gif\n[zoomingScreenshot]: ./screenshots/zooming.gif\n[4]: https://github.com/voghDev/PdfViewPager/blob/master/CHANGELOG.md\n[5]: https://github.com/sephiroth74/ImageViewZoom\n[6]: http://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html\n[7]: https://github.com/voghDev/PdfViewPager/blob/27b61836168a09fec9287726246bd7b3da8aae74/sample/src/main/java/es/voghdev/pdfviewpager/LegacyPDFActivity.java\n[8]: https://github.com/voghDev/PdfViewPager/tree/master/sample/src/main/java/es/voghdev/pdfviewpager\n[9]: https://github.com/voghDev\n[10]: http://www.mobiledevstories.com\n[11]: https://github.com/chrisbanes/PhotoView\n[12]: https://github.com/voghDev/HelloKotlin/blob/pdfviewpager/app/src/main/java/es/voghdev/hellokotlin/PdfViewPagerActivity.kt\n","funding_links":[],"categories":["Java","Viewers","ViewPager"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FvoghDev%2FPdfViewPager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FvoghDev%2FPdfViewPager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FvoghDev%2FPdfViewPager/lists"}