Buscar pacotes, repositórios e categorias de apps

Capa de cosmos_epub
Detalhes do pacotev1.0.1

cosmos_epub

Pacote de leitor de EPUB rico em recursos para Flutter com animações de virar de página, destaque de texto, hifenização, capítulos aninhados infinitos, suporte a imagens, idiomas do RTL, temas e fontes personalizáveis.

AndroidiOS
Downloads em 30 dias
116
Curtidas
46
Pontos Pub
70

Instalar pacote

flutter pub add cosmos_epub

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

Cosmos EPUB é um pacote do Flutter rico em recursos para leitura de arquivos EPUB com animações suaves de virada de página, destaque de texto, hifenização e suporte a capítulos aninhados infinitos. Ele lida com imagens, idiomas da direita para a esquerda e oferece temas e fontes personalizáveis. Ideal para construir aplicativos de leitura imersivos com formatação avançada e recursos de acessibilidade.

Casos de uso

  • Lendo livros digitais no formato EPUB
  • Construindo aplicativos de leitor de e-books
  • Suporte a texto multilíngue e da direita para a esquerda
  • Criando conteúdo educacional interativo
  • Habilitar destaque de texto e anotações

Principais recursos

  • animações de rotação de página
  • Destaque de texto e hifenização
  • Estrutura de capítulo aninhado infinita
  • Suporte a imagem e idioma RTL
  • Temas e fontes personalizáveis

Indicado para

  • leitores de e-books
  • Aplicativos educacionais
  • Plataformas de conteúdo multilíngue
  • Aplicações voltadas para acessibilidade
  • Experiências de leitura personalizáveis

Considerações

  • Requer manipulação cuidadosa de arquivos EPUB grandes
  • Pode precisar de otimização para dispositivos de baixo custo
  • Limitado apenas ao formato EPUB
  • A personalização de tema exige conhecimento em UI
  • Depende de repositório externo no GitHub para atualizações

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

CosmosEpub 💫

A feature-rich EPUB reader package for Flutter with page flip animations, text highlighting, hyphenation, infinite nested chapters, image support, RTL languages, customizable themes and fonts.

Showcase

banner

Features

  • Text Highlighting — select text, pick a color (6 options), highlights persist across sessions. Re-highlight to change color. Copy & Select All support.
  • Hyphenation — syllable-aware word breaking for better justified text. Visible "-" at line breaks. Respects Uzbek digraphs (ch, sh, g', o').
  • Infinite Nested Chapters — recursive TOC with unlimited depth. Section title pages auto-generated.
  • Image Support — EPUB images rendered inline (PNG, JPEG, GIF, SVG, WebP).
  • Page Flip Animation — realistic 3D page curl effect with swipe gestures.
  • 5 Themes — Grey, Purple, White, Black, Pink.
  • 14 Fonts — Alegreya, Amazon Ember, Bookerly, EB Garamond, Lora, Ubuntu, and more.
  • RTL Support — Arabic, Persian, Hebrew, Urdu, and other RTL languages with auto-detection.
  • Reading Progress — chapter and page position saved per book.
  • Brightness Control — in-reader brightness slider.
  • Multiple Sources — open EPUB from assets, local file, URL, or raw bytes.
  • Robust Parsing — 3-tier chapter resolution (NCX NavMap → epubx Chapters → Spine order). Handles malformed EPUBs.

Getting Started

Add the dependency:

dependencies:
  cosmos_epub: ^1.0.0
flutter pub get

Usage

Initialize

Call initialize() once before using any other method (preferably in main.dart):

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await CosmosEpub.initialize();
  runApp(MyApp());
}
Open a Book
// From assets
await CosmosEpub.openAssetBook(
  assetPath: 'assets/book.epub',
  context: context,
  bookId: 'my_book_1',
  accentColor: Colors.indigoAccent,
  onPageFlip: (currentPage, totalPages) {
    print('Page $currentPage of $totalPages');
  },
  onLastPage: (lastPageIndex) {
    print('Reached last page');
  },
);

// From local file
await CosmosEpub.openLocalBook(
  localPath: '/path/to/book.epub',
  context: context,
  bookId: 'my_book_2',
);

// From URL
await CosmosEpub.openURLBook(
  urlPath: 'https://example.com/book.epub',
  context: context,
  bookId: 'my_book_3',
);

// From bytes
await CosmosEpub.openFileBook(
  bytes: myUint8List,
  context: context,
  bookId: 'my_book_4',
);
Progress Management
// Get current progress
BookProgressModel progress = CosmosEpub.getBookProgress('my_book_1');
print('Chapter: ${progress.currentChapterIndex}');
print('Page: ${progress.currentPageIndex}');

// Set progress manually
await CosmosEpub.setCurrentChapterIndex('my_book_1', 5);
await CosmosEpub.setCurrentPageIndex('my_book_1', 3);

// Delete progress
await CosmosEpub.deleteBookProgress('my_book_1');
await CosmosEpub.deleteAllBooksProgress();
Highlight Management
// Get all highlights for a book
List<HighlightModel> highlights = CosmosEpub.getBookHighlights('my_book_1');

// Remove a specific highlight
CosmosEpub.removeHighlight(highlights.first.id);

// Remove all highlights for a book
CosmosEpub.removeAllHighlights('my_book_1');
Clear Theme Cache
await CosmosEpub.clearThemeCache();

Parameters

Parameter Type Default Description
assetPath / localPath / urlPath / bytes String / Uint8List required EPUB source
context BuildContext required Build context for navigation
bookId String required Unique ID for progress tracking
accentColor Color Colors.indigoAccent Primary accent color
onPageFlip Function(int, int)? null Called on page change
onLastPage Function(int)? null Called on last page
chapterListTitle String 'Table of Contents' TOC screen title
shouldOpenDrawer bool false Open TOC on start
starterChapter int -1 Start at specific chapter

RTL Language Support 🌍

Automatic detection and support for Right-to-Left languages:

  • Arabic (العربية), Persian (فارسی), Hebrew (עברית), Urdu (اردو)
  • Pashto (پښتو), Sindhi (سنڌي), Kurdish (کوردی), Dhivehi (ދިވެހި), Yiddish (ייִדיש)

No configuration needed — just open the EPUB and the library handles direction, alignment, and navigation automatically.

Notes

  • Each book must have a unique bookId. Using the same ID for different books will cause progress conflicts.
  • Highlights are stored locally via GetStorage and persist across app restarts.
  • The package uses isar_community for progress persistence (Android/iOS/Desktop only, no web support).

License

BSD-3

Contact

Feel free to open an issue or reach out: https://allmylinks.com/mamasodikov

Categorias

Dependências

Lista de dependências 12 itens

Repositório-fonte

Projetos que usam este pacote

Ainda não há dados.