Popularity
3.8
Growing
Activity
3.6
-
227
8
46

Description

A Simple and lightweight PDF Viewer library which only occupies around 125kb while most of the Pdf viewer occupies upto 16MB space.

Programming language: Kotlin
License: MIT License

Pdf Viewer For Android alternatives and similar packages

Based on the "Kotlin" category.
Alternatively, view Pdf Viewer For Android alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of Pdf Viewer For Android or a related project?

Add another 'Kotlin' Package

README

Pdf Viewer For Android

A Simple PDF Viewer library which only occupies around 125kb while most of the Pdf viewer occupies upto 16MB space.

License

How to integrate into your app?

Integrating the project is simple, All you need to do is follow the below steps

Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:

allprojects {
  repositories {
    ...
    maven { url "https://jitpack.io" }
  }
}

Step 2. Add the dependency

dependencies {
    implementation 'com.github.afreakyelf:Pdf-Viewer:Tag'
}

How to use the library?

Now you have integrated the library in your project but how do you use it? Well its really easy just launch the intent with in following way:

open_pdf.setOnClickListener {
            startActivity(

            // Use 'launchPdfFromPath' if you want to use assets file (enable "fromAssets" flag) / internal directory

                PdfViewerActivity.launchPdfFromUrl(           //PdfViewerActivity.Companion.launchPdfFromUrl(..   :: incase of JAVA       
                    context,                                                                      
                    "pdf_url",                                // PDF URL in String format
                    "Pdf title/name ",                        // PDF Name/Title in String format
                    "pdf directory to save",                  // If nothing specific, Put "" it will save to Downloads
                    enableDownload = false                    // This param is true by defualt.
                )
            )
        } 

That's pretty much it and you're all wrapped up.

Ui Customizations

You need to add the custom theme to styles.xml/themes.xml file and override the required attribute values. Parent theme can be either Theme.PdfView.Light or Theme.PdfView.Dark or the one with no actionbar from the application. Note: If parent is not one of the themes from this library, all of the pdfView attributes should be added to that theme.

<style name="Theme.PdfView.SelectedTheme" parent="@style/Theme.PdfView.Light">
    <item name="pdfView_backIcon">@drawable/ic_arrow_back</item>
    ...
</style>

Supported attributes

Attribute Name Type Expected changes
pdfView_backIcon drawable Navigation icon
pdfView_downloadIcon drawable Download icon
pdfView_downloadIconTint color Download icon tint
pdfView_actionBarTint color Actionbar background color
pdfView_titleTextStyle style Actionbar title text appearance
pdfView_progressBar style Progress bar style

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/NewFeature)
  3. Commit your Changes (git commit -m 'Add some NewFeature')
  4. Push to the Branch (git push origin feature/NewFeature)
  5. Open a Pull Request

Donations

If this project help you reduce time to develop, you can give me a cup of coffee :)

paypal

Author

Maintained by Rajat Mittal


*Note that all licence references and agreements mentioned in the Pdf Viewer For Android README section above are relevant to that project's source code only.