Search categories, packages and repositories

ducafecatFlutter ecosystem guide
Package detailsv0.1.7

epub_kitty

epub_kitty is an epub ebook reader that encapsulates the folioreader framework.

pub.dev API documentation Source code
30-day downloads
56
Likes
32
Pub points
40

Install package

flutter pub add epub_kitty

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

epub_kitty is a Flutter package that provides an EPUB ebook reader by wrapping the folioreader framework. It enables developers to integrate full-featured EPUB reading capabilities into their Flutter applications, supporting interactive content, text selection, and responsive layouts. The package simplifies the process of displaying and navigating EPUB files with minimal setup. It's ideal for apps focused on digital reading, educational content, or library-style interfaces. Built with Flutter, it ensures cross-platform compatibility and smooth performance across devices.

Use cases

  • Digital book readers
  • Educational apps
  • Library applications
  • Interactive e-learning platforms
  • Content-rich mobile apps

Key features

  • EPUB file rendering
  • Text selection and highlighting
  • Responsive layout support
  • Cross-platform compatibility
  • Easy integration with Flutter

Suitable for

  • Flutter developers building reading apps
  • Educational technology projects
  • Publishers distributing digital books
  • Apps requiring offline content access
  • Developers seeking lightweight EPUB solutions

Considerations

  • Limited to EPUB format only
  • Depends on folioreader's stability
  • May require additional styling for custom UI
  • No built-in DRM support
  • Platform-specific behaviors may vary

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

epub_kitty

epub_kitty is an epub ebook reader that encapsulates the folioreader framework. It supports iOS and android, but is customizable on iOS. It is very easy to use, you just need to set up the configuration file can open the ebook, very convenient. However, it is not yet highly customizable on android. But it has been able to meet daily needs.

中文文档

Install

dependencies:
  epub_kitty: ^0.1.7

Simple Use

first step
/**
 * @identifier (android useless)
 * @themeColor
 * @scrollDirection (android useless)
 * @allowSharing (android useless)
 * @shouldHideNavigationOnTap (android useless)
 */
EpubKitty.setConfig("book", "#32a852","vertical",true, shouldHideNavigationOnTap:false);

second step
 /**
 * @bookPath 
 */
EpubReader.open('bookPath');

// page channel used to monitor the current number of pages (only on the ios side)
  static const pageChannel = const EventChannel('com.xiaofwang.epub_kitty/page');

Tool Language

iOS

plugin in ios default language is en,if you are chinese,you should configuare Localizable.strings. And you can see example to match.

android

android default lanuage is chinese before 0.1.7 and later is en, if you used before 0.1.7 ,you should use res/strings.xml to match chinese. see issue #7

issues

if you can not install it, mybe it exists some confict in your plugins or may not full-install.

more solutions see issuses.

Good luck to you !

QQ Communication：

QQ：853797155，Welcome to exchange questions and technologies!

Welcome TO PR

Categories

EPUB

Source repository

Projects using this package

No data available yet.