Android UI OpenSource

FolioReader logo

[Build Status](https://api.travis-ci.org/FolioReader/FolioReader-Android.svg?branch=master)

FolioReader-Android is an EPUB reader written in Java and Kotlin.

Features

• Custom Fonts
• Custom Text Size
• Themes / Day mode / Night mode
• Text Highlighting
• List / Edit / Delete Highlights
• Handle Internal and External Links
• Portrait / Landscape
• Reading Time Left / Pages left
• In-App Dictionary
• Media Overlays (Sync text rendering with audio playback)
• TTS - Text to Speech Support
• Parse epub cover image
• PDF support
• Book Search
• Add Notes to a Highlight
• Better Documentation
• Last Read Locator
• Horizontal Reading
• Distraction Free Reading

Demo

Custom Fonts

Custom fonts

Day and Night Mode

Day night mode

Text Highlighting

Highlight

Media Overlays

Media Overlay

Gradle

Add following dependency to your root project build.gradle file:

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

Add following dependency to your app module build.gradle file:

dependencies {
    ...
    implementation "com.folioreader:folioreader:0.5.4"
    ...
}

Enable Multidex support

Enable Multidex support as explained in this Android Doc

Usage

Get singleton object of FolioReader:

FolioReader folioReader = FolioReader.get();

Call the function openBook():

opening book from assets -

folioReader.openBook("file:///android_asset/TheSilverChair.epub");

opening book from raw -

folioReader.openBook(R.raw.accessible_epub_3);

WIKI

• Home
• Configuration
  • Custom Configuration
• Highlight
  • Highlight Action
  • Highlight Event
  • Providing External Highlight
• ReadLocator
• Clean up code

Reporting Issue

See KNOWN_ISSUES and CHANGELOG first before reporting any issue.

Please follow Issue Template to report any issue.

Share your application

If you are using FolioReader in your application, share your application link in this issue

Credits

1. SwipeLayout
2. r2-streamer-kotlin
3. Pearson Dictionaries
4. rangy

Author

Heberti Almeida

• Follow me on Twitter: @hebertialmeida
• Contact me on LinkedIn: hebertialmeida

CodeToArt Technology

• Follow us on Twitter: @codetoart
• Contact us on Website: codetoart

Donations

This project needs you If you would like to support this project’s further development, the creator of this project or the continuous maintenance of this project, feel free to donate. Your donation is highly appreciated. Thank you

PayPal

• Donate 5 $: Thank’s for creating this project, here’s a tea (or some juice) for you
• Donate 10 $: Wow, I am stunned. Let me take you to the movies
• Donate 15 $: I really appreciate your work, let’s grab some lunch
• Donate 25 $: That’s some awesome stuff you did right there, dinner is on me
• Donate 50 $: I really really want to support this project, great job
• Donate 100 $: You are the man This project saved me hours (if not days) of struggle and hard work, simply awesome
• Of course, you can also choose what you want to donate, all donations are awesome

License

FolioReaderKit is available under the BSD license. See the LICENSE file.