epub_view 1.0.0
epub_view: ^1.0.0

Flutter Android iOS

Flutter widget for view EPUB documents on on Web, MacOs, Android and iOS. Based on dart-epub package.

epub_view #

Flutter widget for view EPUB documents on all platforms. Based on epub package. Render with flutter widgets (not native view) on Web, MacOs, Android and iOS

for Web a bug is noticed, see flutter_html issue#300

Showcase #

Getting Started #

In your flutter project add the dependency:

pub package

dependencies:
  epub_view: any

Usage example: #

import 'dart:typed_data';

import 'package:flutter/material.dart';
import 'package:flutter_epub/flutter_epub.dart';
import 'package:flutter/services.dart' show rootBundle;

Future<Uint8List> _loadFromAssets(String assetName) async {
  final bytes = await rootBundle.load(assetName);
  return bytes.buffer.asUint8List();
}

EpubController _epubController;

@override
void initState() {
  _epubController = EpubController(
    // Future<Uint8List>
    data: _loadFromAssets('assets/book.epub'),
    // or pure Uint8List
    // document: EpubReader.readBook(data),
  );
  super.initState();
}

@override
Widget build(BuildContext context) => Scaffold(
  appBar: AppBar(
    // Show actual chapter name
    title: EpubActualChapter(
      controller: _epubController,
      builder: (chapterValue) => Text(
        'Chapter ${chapterValue.chapter.Title ?? ''}',
        textAlign: TextAlign.start,
      ),
    ),
  ),
  // Show table of contents
  drawer: Drawer(
    child: EpubReaderTableOfContents(
      controller: _epubController,
    ),
  ),
  // Show epub document
  body: EpubView(
    controller: _epubController,
  ),
);

How start from last view position? #

This method allows you to keep the exact reading position even inside the chapter:

_epubController = EpubController(
  // initialize with epub cfi string for open book from last position
  epubCfi: 'epubcfi(/6/6[chapter-2]!/4/2/1612)',
);

// Attach controller
EpubView(
  controller: _epubController,
);

// Get epub cfi string
// for example output - epubcfi(/6/6[chapter-2]!/4/2/1612)
final cfi = _epubController.generateEpubCfi();

// or usage controller for navigate
_epubController.gotoEpubCfi('epubcfi(/6/6[chapter-2]!/4/2/1612)');
20
likes
80
pub points
74%
popularity

Publisher

serge.software

Flutter widget for view EPUB documents on on Web, MacOs, Android and iOS. Based on dart-epub package.

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

epub, equatable, flutter, flutter_html, html, meta, rxdart, scrollable_positioned_list

More

Packages that depend on epub_view