View on GitHub
Install in Dash
FolioReaderConfig Class Reference
FolioReaderConfig
open class FolioReaderConfig : NSObjectDefines the Reader custom configuration
-
Array of
ClassBasedOnClickListenerobjects. AClassBasedOnClickListenertakes a closure which is performed if a given htmlclassis clicked. The closure will reveice the content of the specified parameter.Eg. A ClassBasedOnClickListener with the className
quoteand parameterNameidwith the given epub html content<section class="quote" id="12345">would call the given closure on a click on this section with the String12345as parameter.Declaration
Swift
open var classBasedOnClickListeners: [ClassBasedOnClickListener]
-
Base header custom TintColor
Declaration
Swift
open var tintColor: UIColor -
Menu background color
Declaration
Swift
open var menuBackgroundColor: UIColor -
Menu separator Color
Declaration
Swift
open var menuSeparatorColor: UIColor -
Menu text color
Declaration
Swift
open var menuTextColor: UIColor -
Night mode background color
Declaration
Swift
open var nightModeBackground: UIColor -
Night mode menu background color
Declaration
Swift
open var nightModeMenuBackground: UIColor -
Night mode separator color
Declaration
Swift
open var nightModeSeparatorColor: UIColor -
Media overlay or TTS selection color
Declaration
Swift
open lazy var mediaOverlayColor: UIColor! { get set }
-
hide the navigation bar and the bottom status view
Declaration
Swift
open var hideBars: Bool -
If
canChangeScrollDirectionistrueit will be overrided by user’s option.Declaration
Swift
open var scrollDirection: FolioReaderScrollDirection -
Enable or disable hability to user change scroll direction on menu.
Declaration
Swift
open var canChangeScrollDirection: Bool -
Should hide navigation bar on user tap
Declaration
Swift
open var shouldHideNavigationOnTap: Bool -
Allow sharing option, if
falsewill hide all sharing icons and optionsDeclaration
Swift
open var allowSharing: Bool -
Enable TTS (Text To Speech)
Declaration
Swift
open var enableTTS: Bool -
Display book title in navbar
Declaration
Swift
open var displayTitle: Bool -
Hide the page indicator
Declaration
Swift
open var hidePageIndicator: Bool -
Go to saved position when open a book
Declaration
Swift
open var loadSavedPositionForCurrentBook: Bool
-
Custom Quote logo
Declaration
Swift
open var quoteCustomLogoImage: UIImage? -
Add custom backgrounds and font colors to Quote Images
Declaration
Swift
open var quoteCustomBackgrounds: [QuoteImage] -
Enable or disable default Quote Image backgrounds
Declaration
Swift
open var quotePreserveDefaultBackgrounds: Bool
-
Realm configuration for storing highlights
Declaration
Swift
open var realmConfiguration: Realm.Configuration
-
Localizes Highlight title
Declaration
Swift
open var localizedHighlightsTitle: String -
Localizes Content title
Declaration
Swift
open var localizedContentsTitle: String -
Use the readers
UIMenuControllerwhich enables the highlighting etc. The default istrue. If set to false it’s possible to modify the sharedUIMenuControllerfor yourself. Note: This doesn’t disable the text selection in the web view.Declaration
Swift
open var useReaderMenuController: Bool -
Used to distinguish between multiple or different reader instances. The content of the user defaults (font settings etc.) depends on this identifier. The default is
nil.Declaration
Swift
open var identifier: String? -
Localizes Highlight date format. This is a
dateFormatfromNSDateFormatter, so be careful 🤔Declaration
Swift
open var localizedHighlightsDateFormat: String -
Declaration
Swift
open var localizedHighlightMenu: String -
Declaration
Swift
open var localizedDefineMenu: String -
Declaration
Swift
open var localizedPlayMenu: String -
Declaration
Swift
open var localizedPauseMenu: String -
Declaration
Swift
open var localizedFontMenuNight: String -
Declaration
Swift
open var localizedPlayerMenuStyle: String -
Declaration
Swift
open var localizedFontMenuDay: String -
Declaration
Swift
open var localizedLayoutHorizontal: String -
Declaration
Swift
open var localizedLayoutVertical: String -
Declaration
Swift
open var localizedReaderOnePageLeft: String -
Declaration
Swift
open var localizedReaderManyPagesLeft: String -
Declaration
Swift
open var localizedReaderManyMinutes: String -
Declaration
Swift
open var localizedReaderOneMinute: String -
Declaration
Swift
open var localizedReaderLessThanOneMinute: String -
Declaration
Swift
open var localizedShareWebLink: URL? -
Declaration
Swift
open var localizedShareChapterSubject: String -
Declaration
Swift
open var localizedShareHighlightSubject: String -
Declaration
Swift
open var localizedShareAllExcerptsFrom: String -
Declaration
Swift
open var localizedShareBy: String -
Declaration
Swift
open var localizedCancel: String -
Declaration
Swift
open var localizedShare: String -
Declaration
Swift
open var localizedChooseExisting: String -
Declaration
Swift
open var localizedTakePhoto: String -
Declaration
Swift
open var localizedShareImageQuote: String -
Declaration
Swift
open var localizedShareTextQuote: String -
Declaration
Swift
open var localizedSave: String -
Declaration
Swift
open var localizedHighlightNote: String -
Declaration
Swift
public convenience init(withIdentifier identifier: String)