FolioReader-Android is an EPUB reader written in Java and Kotlin.
- 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
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 as explained in this Android Doc
Add following lines in the gradle.properties file if you face checkDebugDuplicateClasses
or Manifest merger
issue during build
android.useAndroidX=true
android.enableJetifier=true
Get singleton object of FolioReader
:
FolioReader folioReader = FolioReader.get();
Call the function openBook()
:
folioReader.openBook("file:///android_asset/the_silver_chair.epub");
folioReader.openBook(R.raw.accessible_epub_3);
Create an object Config config = new Config()
;
config.setShowBookMarkBtn(false);
config.setShowSizeChangerBtn(false);
config.setShowSearchBtn(false);
config.setShowBackBtn(true);
Then pass the object config
to folioReader.setConfig(config, true)
function:
folioReader.setConfig(config, true)
.openBook("file:///android_asset/the_silver_chair.epub");
See KNOWN_ISSUES and CHANGELOG first before reporting any issue.
Please follow Issue Template to report any issue.
If you are using FolioReader in your application, share your application link in this issue
- Follow me on Twitter: @hebertialmeida
- Contact me on LinkedIn: hebertialmeida
- Follow us on Twitter: @codetoart
- Contact us on Website: codetoart
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!
FolioReaderKit is available under the BSD license. See the LICENSE file.