Search packages, repositories and app categories

Package detailsv1.0.0-beta.2

vector_epub_reader

A customizable Flutter package for reading EPUB files. Developed by Myat Min Lu(vector.com.mm)

AndroidiOSWebmacOSWindowsLinux
30-day downloads
46
Likes
3
Pub points
120

Install package

flutter pub add vector_epub_reader

Package Overview

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

A customizable Flutter package for reading EPUB files across multiple platforms. Developed by Myat Min Lu, it enables seamless integration of EPUB content into Flutter applications with support for Android, iOS, Web, macOS, Windows, and Linux. The package provides a clean API for loading and displaying EPUBs, allowing developers to tailor the reader's appearance and behavior. It is ideal for e-book apps, educational tools, or any application requiring offline document reading.

Use cases

  • E-book applications
  • Educational platforms
  • Offline document readers
  • Digital library integrations
  • Content delivery apps

Key features

  • Cross-platform EPUB support
  • Customizable UI
  • Lightweight and efficient
  • Supports all major operating systems
  • Easy integration with Flutter

Suitable for

  • Developers building e-reader apps
  • Educational app creators
  • Content publishers
  • Mobile and desktop app teams

Considerations

  • Requires EPUB file validation
  • Limited advanced formatting support
  • No built-in search functionality
  • Depends on external rendering engine
  • May need additional styling for complex layouts

Original README

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

Customization

The EpubReader widget has several properties you can use to customize the look:

  • epubUrl: The URL of the EPUB file to load.
  • backgroundColor: Background color of the reader.
  • textColor: Color of the text in the content.
  • settingsBackgroundColor: Background color of the settings overlay.
  • settingsTextColor: Text color for the settings overlay.
  • appBarColor: Background color of the AppBar.
  • appBarTextColor: Text color of the AppBar title.
  • drawerBackgroundColor: Background color of the chapter drawer.
  • drawerTextColor: Text color of the chapter titles in the drawer.
  • navigationBarColor: Background color of the navigation bar.
  • navigationTextColor: Text color for the navigation bar items.
  • appBarIconColor: Color of the icons on the AppBar.
  • appBarIconDisabledColor: Color of the disabled icons on the AppBar.

Users can also customize font size, line height, and content padding using the settings modal.

Example

For a more detailed example of how to use the package, see the example/ folder in the repository.

Contributing

Contributions are welcome! Please open issues or submit pull requests on the GitHub repository.

Categories

Dependencies

Dependency list 7 items

Source repository

Projects using this package

No data available yet.