/FolioReaderKit

A Swift ePub reader and parser framework for iOS.

Primary LanguageSwiftBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

FolioReader logo 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 NEW
  • Share Custom Image Quotes NEW
  • Book Search
  • Add Notes to a Highlight

Demo

Custom Fonts 😏

Custom fonts

Day and Night Mode 😎

Day night mode

Text Highlighting 😍

Highlight

Reading Time Left 😮

Time left

Media Overlays 😭

Time left

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, '8.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 8.0+
  • Xcode 8.2+

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")
    FolioReader.presentReader(parentViewController: self, withEpubPath: bookPath!, andConfig: config)
}

You can also use your own FolioReader View Controller like this.

let config = FolioReaderConfig()
let bookPath = Bundle.main.path(forResource: "book", ofType: "epub")
let epubVC = FolioReaderContainer(withConfig: config, epubPath: bookPath!, removeEpub: true)

// Present the epubVC view controller like every other UIViewController instance
present(epubVC, animated: true, completion: nil)

In your AppDelegate call applicationWillResignActive and applicationWillTerminate. This will save the reader state even if you kill the app.

import FolioReaderKit

func applicationWillResignActive(_ application: UIApplication) {
    FolioReader.applicationWillResignActive()
}

func applicationWillTerminate(_ application: UIApplication) {
    FolioReader.applicationWillTerminate()
}

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

For now the best documentation is the sample project. I will write a better am working to improve the code documentation, this is the current progress: CocoaPods

You have a problem that cannot be solved by having a look at the example project? No problem, let's talk: Join the chat at https://gitter.im/FolioReader/FolioReaderKit

Author

Heberti Almeida

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

License

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