Awesome Open Source
Awesome Open Source

FolioReader logo FolioReaderKit is an ePub reader and parser framework for iOS written in Swift.

Version License


  • [x] ePub 2 and ePub 3 support
  • [x] Custom Fonts
  • [x] Custom Text Size
  • [x] Text Highlighting
  • [x] List / Edit / Delete Highlights
  • [x] Themes / Day mode / Night mode
  • [x] Handle Internal and External Links
  • [x] Portrait / Landscape
  • [x] Reading Time Left / Pages left
  • [x] In-App Dictionary
  • [x] Media Overlays (Sync text rendering with audio playback)
  • [x] TTS - Text to Speech Support
  • [x] Parse epub cover image
  • [x] RTL Support
  • [x] Vertical or/and Horizontal scrolling
  • [x] Share Custom Image Quotes NEW
  • [x] 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.


Custom Fonts šŸ˜ Text Highlighting šŸ˜
Custom fonts Highlight
Reading Time Left šŸ˜® Media Overlays šŸ˜­
Time left Media Overlays


FolioReaderKit is available through CocoaPods and Carthage.


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 ''
platform :ios, '9.0'

target '<Your Target Name>' do
    pod 'FolioReaderKit'

Then, run the following command:

$ pod install

Alternatively to give it a test run, run the command:

$ pod try FolioReaderKit


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.


  • 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.


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.


Checkout Example and API Documentation

You can always use the header-doc. (use alt+click in Xcode)


If you are migrating to a newer version check out MIGRATION and CHANGELOG.


Heberti Almeida


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

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
swift (7,620)Ā 
ios (3,544)Ā 
epub (95)Ā 
highlight (64)Ā 
night-mode (23)Ā 

Find Open Source By Browsing 7,000 Topics Across 59 Categories

Advertising šŸ“¦Ā 10
All Projects
Application Programming Interfaces šŸ“¦Ā 124
Applications šŸ“¦Ā 192
Artificial Intelligence šŸ“¦Ā 78
Blockchain šŸ“¦Ā 73
Build Tools šŸ“¦Ā 113
Cloud Computing šŸ“¦Ā 80
Code Quality šŸ“¦Ā 28
Collaboration šŸ“¦Ā 32
Command Line Interface šŸ“¦Ā 49
Community šŸ“¦Ā 83
Companies šŸ“¦Ā 60
Compilers šŸ“¦Ā 63
Computer Science šŸ“¦Ā 80
Configuration Management šŸ“¦Ā 42
Content Management šŸ“¦Ā 175
Control Flow šŸ“¦Ā 213
Data Formats šŸ“¦Ā 78
Data Processing šŸ“¦Ā 276
Data Storage šŸ“¦Ā 135
Economics šŸ“¦Ā 64
Frameworks šŸ“¦Ā 215
Games šŸ“¦Ā 129
Graphics šŸ“¦Ā 110
Hardware šŸ“¦Ā 152
Integrated Development Environments šŸ“¦Ā 49
Learning Resources šŸ“¦Ā 166
Legal šŸ“¦Ā 29
Libraries šŸ“¦Ā 129
Lists Of Projects šŸ“¦Ā 22
Machine Learning šŸ“¦Ā 347
Mapping šŸ“¦Ā 64
Marketing šŸ“¦Ā 15
Mathematics šŸ“¦Ā 55
Media šŸ“¦Ā 239
Messaging šŸ“¦Ā 98
Networking šŸ“¦Ā 315
Operating Systems šŸ“¦Ā 89
Operations šŸ“¦Ā 121
Package Managers šŸ“¦Ā 55
Programming Languages šŸ“¦Ā 245
Runtime Environments šŸ“¦Ā 100
Science šŸ“¦Ā 42
Security šŸ“¦Ā 396
Social Media šŸ“¦Ā 27
Software Architecture šŸ“¦Ā 72
Software Development šŸ“¦Ā 72
Software Performance šŸ“¦Ā 58
Software Quality šŸ“¦Ā 133
Text Editors šŸ“¦Ā 49
Text Processing šŸ“¦Ā 136
User Interface šŸ“¦Ā 330
User Interface Components šŸ“¦Ā 514
Version Control šŸ“¦Ā 30
Virtualization šŸ“¦Ā 71
Web Browsers šŸ“¦Ā 42
Web Servers šŸ“¦Ā 26
Web User Interface šŸ“¦Ā 210