FolioReaderKit is an ePub reader and parser framework for iOS written in Swift.
Features
- ePub 2 and ePub 3 support
- Custom Fonts
- Custom Text Size
- Text Highlighting
- List / Edit / Delete Highlights
- Themes / Day mode / Night mode
- 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
- RTL Support
- Vertical or/and Horizontal scrolling
- Share Custom Image Quotes NEW
- Support multiple instances at same time, like parallel reading NEW
- Book Search
- Add Notes to a Highlight
Who is using it?
On AppSight you can see apps that are using it in production.
Demo
| Custom Fonts
|
Text Highlighting
|
|---|---|
 |
 |
| Reading Time Left
|
Media Overlays
|
|---|---|
 |
 |
Installation
FolioReaderKit is available through CocoaPods and Carthage.
Cocoapods
CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:
$ gem install cocoapods
To integrate FolioReaderKit into your Xcode project using CocoaPods, specify it in your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
target '<Your Target Name>' do
pod 'FolioReaderKit'
end
Then, run the following command:
$ pod install
Alternatively to give it a test run, run the command:
$ pod try FolioReaderKit
Carthage
Add the following to your Cartfile
github "FolioReader/FolioReaderKit"
Run the following command:
$ carthage update --platform iOS --no-use-binaries
Then, follow the steps as described in Carthage's README.
Requirements
- iOS 9.0+
- Xcode 10.1+
Basic Usage
To get started, this is a simple usage sample of using the integrated view controller.
import FolioReaderKit
func open(sender: AnyObject) {
let config = FolioReaderConfig()
let bookPath = Bundle.main.path(forResource: "book", ofType: "epub")
let folioReader = FolioReader()
folioReader.presentReader(parentViewController: self, withEpubPath: bookPath!, andConfig: config)
}
For more usage examples check the Example folder.
Storyboard
To get started, here is a simple example how to use the integrated view controller with storyboards.
import FolioReaderKit
class StoryboardFolioReaderContrainer: FolioReaderContainer {
required init?(coder aDecoder: NSCoder) {
super.init(coder: aDecoder)
let config = FolioReaderConfig()
config.scrollDirection = .horizontalWithVerticalContent
guard let bookPath = Bundle.main.path(forResource: "The Silver Chair", ofType: "epub") else { return }
setupConfig(config, epubPath: bookPath)
}
}
Go to your storyboard file, choose or create the view controller that should present the epub reader. In the identity inspector set StoryboardFolioReaderContrainer as class.
Documentation
Checkout Example and API Documentation
You can always use the header-doc. (use alt+click in Xcode)
Migration
If you are migrating to a newer version check out MIGRATION and CHANGELOG.
Author
- Follow me on Twitter: @hebertialmeida
- Contact me on LinkedIn: hebertialmeida
License
FolioReaderKit is available under the BSD license. See the LICENSE file.
269 Dec 11, 2022
10 Sep 2, 2022
6 Nov 22, 2022
0 Feb 7, 2022
31 Sep 15, 2022
582 Jan 6, 2023
1.2k Dec 22, 2022
6 Jun 14, 2022
712 Dec 29, 2022
238 Dec 29, 2022
4 Jul 22, 2022
1 Feb 25, 2022
2.5k Jan 8, 2023
104 Dec 15, 2022
685 Jan 2, 2023
421 Jan 2, 2023
6.3k Dec 29, 2022
249 Dec 12, 2022
13 Nov 29, 2022