Starlight epub viewer - Epub viewer for flutter

Ye Myo Aung

Last update: Oct 17, 2022

Related tags

SwiftUI App starlight_epub_viewer

Overview

Starlight Epub Viewer

starlight_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	✅	✅
Highlight And Notes	✅	✅
Load ePub from Asset	✅	✅
Share	✅	✅
Distraction Free Reading	✅	✅

ScreenShots (Android)

ScreenShots (Ios)

Installation

Add starlight_epub_viewer as dependency to your pubspec file.

   starlight_epub_viewer: 
    git:
      url: https://github.com/YeMyoAung/starlight_epub_viewer.git

Android Setup

No additional integration steps are required for Android.

Ios Setup

This plugin requires Swift to work on iOS.

Add the following lines in the Podfile file of your iOS project

platform :ios, '9.0'
...
target 'Runner' do
  use_frameworks!
  use_modular_headers!
  pod 'FolioReaderKit', :git => 'https://github.com/YeMyoAung/starlight_folioreader.git'
  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
end

Usage

First of all you need to import our package.

import 'package:starlight_epub_viewer/starlight_epub_viewer.dart';

And then you can use easily.

  /// Config
  StarlightEpubViewer.setConfig(
    ///for viewer color
    themeColor: Colors.blue,
    ///night mode for viewer
    nightMode: false,
    ///scroll direction for viewer
    scrollDirection: StarlightEpubViewerScrollDirection.ALLDIRECTIONS,
    ///if you want to share your epub file
    allowSharing: true,
    ///enable the inbuilt Text-to-Speech
    enableTts: true,
    ///if you want to show remaining 
    setShowRemainingIndicator: true,
  );
  
  /// Open From File
  StarlightEpubViewer.open(
      "file path",
  );
  
  /// Open From Assets Folder
  StarlightEpubViewer.openAsset(
      "assets file path",
  );

Contact Us

Starlight Studio

You might also like...

DTPhotoViewerController - A fully customizable photo viewer ViewController to display single photo or collection of photos, inspired by Facebook photo viewer.

DTPhotoViewerController Example Demo video: https://youtu.be/aTLx4M4zsKk DTPhotoViewerController is very simple to use, if you want to display only on

277 Dec 17, 2022

Flutter & flutter_boost开发iOS混合开发项目问题记录；iOS远程依赖Flutter Module组件代码；

[TOC] 这个仓库主要有2部分，整理了如何在iOS项目导入FlutterModule组件代码，以及整理开发过程中遇到的一些问题和对应的解决方案。在iOS项目依赖FlutterModule组件代码依赖Flutter组件代码的分为本地依赖、远程依赖2种。下面介绍的前3种是本地依赖，同时也是官方推荐

18 Nov 18, 2022

Realtime yoga pose detection and classification plugin for Flutter using MLKit

8 May 5, 2022

Corona Virus Tracker & Advices App with Flutter

Corona Virus Tracker & Advices App with Flutter Try the web app dev preview https://alfian-flutter-coronatracker.firebaseapp.com/ Features Current sta

88 Dec 19, 2022

A Flutter plugin (platform channel with Swift) to get the current app name and also bring our app to the front.

window_to_front A new flutter plugin project. Getting Started This project is a starting point for a Flutter plug-in package, a specialized package th

1 Nov 13, 2021

Flutter package for detecting NSFW images and videos using native implementation

Flutter NSFW 1- Download, tflite modle and put it in assets folder 2 - Add the path of the tfliet to pubspec.yaml 3 - Read the file using path_provide

8 Oct 16, 2022

A apple search ads attribution plugin for flutter

0 Oct 27, 2021

Projeto utilizando Flutter para desenvolver uma aplicação com o objetivo de gerenciar uma lista de livros, como se fosse uma biblioteca, sendo possível adicionar, editar e excluir livros.

todo_list_flutter A new Flutter application. Getting Started This project is a starting point for a Flutter application. A few resources to get you st

0 Nov 4, 2021

Mi Card App for Android & IOS in Flutter

Comments

Error running pod install

Hello, i faced with pod install error

[!] CocoaPods could not find compatible versions for pod "Realm":
      In Podfile:
        starlight_epub_viewer (from `.symlinks/plugins/starlight_epub_viewer/ios`) was resolved to
        0.0.1, which depends on
          FolioReaderKit (~> 1.4.0) was resolved to 1.4.0, which depends on
            RealmSwift (= 3.13.1) was resolved to 3.13.1, which depends on
              Realm (= 3.13.1)

        starlight_epub_viewer (from `.symlinks/plugins/starlight_epub_viewer/ios`) was resolved to
        0.0.1, which depends on
          Realm (~> 10.28.3)

opened by chuiizeet 1

How do i fix this
android:exported needs to be explicitly specified for element <activity#com.folioreader.ui.activity.SearchActivity>. Apps targeting Android 12 and higher are required to specify an explicit value for `android:exported` when the corresponding component has an intent filter defined. See https://developer.android.com/guide/topics/manifest/activity-element#exported for details.

FAILURE: Build failed with an exception.

What went wrong: Execution failed for task ':app:processDebugMainManifest'.

Manifest merger failed : android:exported needs to be explicitly specified for element <activity#com.folioreader.ui.activity.SearchActivity>. Apps targeting Android 12 and higher are required to specify an explicit value for android:exported when the corresponding component has an intent filter defined. See https://developer.android.com/guide/topics/manifest/activity-element#exported for details.
opened by JohnKinyanjui 1

Could not find com.jideguru:folioreader:0.6.2

Hello please I'm having issues getting this to work.

FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':app:checkDebugAarMetadata'.
> Could not resolve all files for configuration ':app:debugRuntimeClasspath'.
   > Could not find com.jideguru:folioreader:0.6.2.
     Searched in the following locations:
       - https://dl.google.com/dl/android/maven2/com/jideguru/folioreader/0.6.2/folioreader-0.6.2.pom
       - https://repo.maven.apache.org/maven2/com/jideguru/folioreader/0.6.2/folioreader-0.6.2.pom
       - https://storage.googleapis.com/download.flutter.io/com/jideguru/folioreader/0.6.2/folioreader-0.6.2.pom
       - https://jitpack.io/com/jideguru/folioreader/0.6.2/folioreader-0.6.2.pom
     Required by:
         project :app > project :starlight_epub_viewer

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

opened by papakay 0