file-viewer/packages/renderers/ebook

@file-viewer/renderer-epub

Standalone ebook renderer package for Flyfish File Viewer. It handles .epub parsing, table-of-contents navigation, scrolling reading, previous/next navigation, reading progress, and .umd mobile ebook metadata, TOC, and zlib text blocks.

Usage

import FileViewer from '@file-viewer/vue3'
import { ebookRenderer } from '@file-viewer/renderer-epub'

const options = {
  builtinRenderers: 'none',
  renderers: ebookRenderer,
}

You can also compose it with other renderers:

import { ebookRenderer } from '@file-viewer/renderer-epub'
import { pdfRenderer } from '@file-viewer/renderer-pdf'
import { archiveRenderer } from '@file-viewer/renderer-archive'

const options = {
  builtinRenderers: 'none',
  renderers: [pdfRenderer, archiveRenderer, ebookRenderer],
}

Capabilities

• Parses .epub packages, OPF metadata, navigation, and chapter resources with epubjs.
• Parses .umd mobile ebook containers with the project parser and inflates text blocks through pako.
• Uses scrolling reading mode for compatibility, avoiding blank content in browsers that struggle with very wide paginated EPUB layouts.
• Supports TOC visibility, chapter jumping, previous/next navigation, and reading progress.
• Does not depend on any online service or public CDN, making it suitable for intranet knowledge bases, training materials, and long-form attachment preview.

Migration Note

The core package no longer bundles the EPUB / UMD renderer and no longer installs epubjs or pako directly. Install this renderer explicitly, or use @file-viewer/preset-all, when ebook preview is required.