パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v3.0.0

vocsy_epub_viewer

vocsy_epub_viewer は、folioreader フレームワークをカプセル化した ePub エブックリーダーです。

AndroidiOS
30日間ダウンロード
86
いいね数
98
Pub ポイント
140

パッケージをインストール

flutter pub add vocsy_epub_viewer

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

vocsy_epub_viewer は、folioreader フレームワークをラップして EPUB ブックリーダーを提供する Flutter パッケージです。Android および iOS プラットフォーム上の Flutter アプリケーションで EPUB ファイルのスムーズな読書を可能にします。ページめくり、テキスト選択、ブックマークなどの機能を備えたクリーンでカスタマイズ可能なインターフェースを提供しています。EPUB サポートをアプリに組み込みたい開発者向けに設計されており、下位ライブラリの深い知識がなくても EPUB コンテンツを扱うプロセスを簡単にします。

用途

  • FlutterアプリでEPUB本を読む
  • デジタル図書館機能の統合
  • 教育またはeラーニングアプリケーションの構築
  • カスタム電子書籍リーダーの作成
  • インタラクティブな教科書を埋め込む

主な機能

  • folioreader フレームワークに基づいて構築されています
  • Android および iOS をサポート
  • カスタマイズ可能な UI コンポーネント
  • ページナビゲーションとテキスト選択
  • ブックマークおよび注釈のサポート

適している対象

  • 教育アプリ開発者
  • デジタル出版プラットフォーム
  • 電子書アプリ開発者
  • モバイル学習ツール
  • コンテンツ豊富なFlutterアプリケーション

注意事項

  • EPUB形式のみ対応
  • folioreader の安定性に依存しています
  • UI の一貫性を確保するために追加のスタイル設定が必要になる場合があります
  • 組み込みの検索機能はありません
  • EPUB のファイルパスを手動で処理する必要があります

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Vocsy Epub Viewer pub package

originally a fork of epub_kitty with few more features. i made this out of epub_kitty because the author was inactive(he isn't merging PRs or attending to issues) and i started having alot of issues with the plugin

vocsy_epub_viewer is an epub ebook reader that encapsulates the folioreader framework. It supports iOS and android.

Features

Name Android iOS
Reading Time Left / Pages left ✅ ✅
Last Read Locator ✅ ✅
Distraction Free Reading ✅ ❌
Load E-Pub from Asset ✅ ✅
Copy and Share Text ✅ ✅
Highlight Text ✅ ✅
Multiple Theme [Light / Dark] ✅ ❌
Support Multiple Device Language ✅ ✅
Change FontStyle ✅ ❌
Android 13 Supported ✅ ❌

ScreenShots

  • Light                  

  • Dark

              

Install

This plugin requires Swift to work on iOS. Also, the minimum deployment target is 9.0

platform :ios, '9.0'

Import into pubspec.yaml

dependencies:
  vocsy_epub_viewer: latest_version

NOTE Please add this to the release build type in your app build.gradle to avoid crashes on android release builds

minifyEnabled false
shrinkResources false

NOTE Add These Lines In manifest

  
  • 1
    <uses-permission android:name="android.permission.INTERNET" />
  • 2
   xmlns:tools="http://schemas.android.com/tools"
  • 3
   android:usesCleartextTraffic="true"
   android:requestLegacyExternalStorage="true"
   android:networkSecurityConfig="@xml/network_security_config"
  • 4
   android:exported="true"

NOTE android -> app -> src -> main -> res -> xml Inside xml Folder create xml file network_security_config.xml

Usage

VocsyEpub.setConfig(
           themeColor: Theme.of(context).primaryColor,
           identifier: "iosBook",
           scrollDirection: EpubScrollDirection.ALLDIRECTIONS,
           allowSharing: true,
           enableTts: true,
           nightMode: true,
       );

/**
 * @bookPath
 * @lastLocation (optional and only android)
 */
VocsyEpub.open(
          'bookPath',
           lastLocation: EpubLocator.fromJson({
	   "bookId": "2239",
	   "href": "/OEBPS/ch06.xhtml",
	   "created": 1539934158390,
	   "locations": {
		"cfi": "epubcfi(/0!/4/4[simple_book]/2/2/6)"
	          }
	    }), // first page will open up if the value is null
        );

// Get locator which you can save in your database

VocsyEpub.locatorStream.listen((locator) {
	print('LOCATOR: ${EpubLocator.fromJson(jsonDecode(locator))}');
	// convert locator from string to json and save to your database to be retrieved later
});

You can also load epub from your assets using EpubViewer.openAsset()

await VocsyEpub.openAsset('assets/3.epub',
lastLocation: EpubLocator.fromJson({
	"bookId": "2239",
	"href": "/OEBPS/ch06.xhtml",
	"created": 1539934158390,
	"locations": {
	"cfi": "epubcfi(/0!/4/4[simple_book]/2/2/6)"
	  }
	}), // first page will open up if the value is null
   );

// Get locator which you can save in your database

VocsyEpub.locatorStream.listen((locator) {
	print('LOCATOR: ${EpubLocator.fromJson(jsonDecode(locator))}');
	// convert locator from string to json and save to your database to be retrieved later
});

Check the Example for implementation

Issues

If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on Github and I'll look into it. Pull request are also welcome.

For help getting started with Flutter, view the online documentation.

For help on editing plugin code, view the documentation.

カテゴリー

依存関係

依存関係一覧 2 件

ソースリポジトリ

このパッケージを使用しているプロジェクト