futurepress/epub.js

Features

• Digital Book Renderers - Implements a comprehensive system for rendering digital books in the browser with paginated and continuous scrolling views.
• Content Fragment Identifiers - Implements a specialized system using Content Fragment Identifiers to track precise text positions for stable bookmarks and annotations.
• Document Rendering - Renders document pages onto a visual canvas using configurable layouts and viewing directions.
• Digital Content Annotations - Supports adding, removing, and styling highlights and marks on specific text ranges using location identifiers.
• Digital Publication Renderers - Provides a layout engine for rendering e-books and digital publications within a browser environment.
• EPUB Structure Parsing - Provides tools to programmatically extract the spine and manifest of EPUB documents for building navigation menus.
• Web-Based Readers - Offers a set of tools for building web-based readers with integrated pagination and scrolling.
• Reading Location Management - Generates and converts reading positions between percentages, page numbers, and precise location identifiers.
• Content Fragment Identifiers - Uses Content Fragment Identifiers to track and resolve precise text positions for stable bookmarking and highlights.
• Layout Modes - Supports multiple viewing modes including paginated spreads and continuous scrolling for digital publications.
• Pagination Controls - Provides pagination controls to move sequentially through a document, simulating a traditional reading experience.
• Pagination Navigation - Handles pagination and page-turning logic to move through documents sequentially or via location jumps.
• Document Annotators - Captures and displays text highlights and notes within the document to track reader progress.
• Web-Based Readers - Provides a browser-based interface for rendering and interacting with EPUB documents.
• Spine-Based Loading - Loads and renders document sections sequentially based on the EPUB manifest list defining the book's order.
• EPUB Rendering Libraries - A JavaScript library for parsing and displaying EPUB files in the browser using configurable layouts.
• Reading Progress Tracking - Tracks and persists the exact reading position and user preferences across different sessions.
• Text Search and Marking - Allows locating specific text strings within document sections and returning their positions as ranges.
• Document Structure Navigators - Allows movement through content using sequential page navigation or jumps to specific locations via identifiers.
• User Preference Persistence - Saves and restores the reader's current progress and UI preferences across different sessions.
• Render Lifecycle Events - Registers custom functions to manipulate content or inject assets during specific rendering lifecycle stages.
• Local File System Integration - Enables opening and rendering EPUB documents uploaded by users from their local file system.
• Iframe Sandboxing - Renders book content within isolated iframes to prevent style leakage and ensure a controlled execution environment.
• Lifecycle Event Hooks - Allows external scripts to intercept the loading and rendering process via registered callback functions.
• Document Bookmarks - Tracks specific locations within a document to allow users to return to saved pages or sections.
• Content Layout Controls - Controls the viewport, text direction, writing mode, and column scaling of the rendered content.
• DOM Range Manipulations - Maps visual text selections to internal document identifiers by calculating paths from the root node.
• Typography - Allows modification of font sizes and families to customize how text appears to the reader.
• Visual Themes - Applies CSS stylesheets or inline style objects to change the overall visual appearance of rendered text.
• Asset Injection - Enables appending custom stylesheets and scripts into the document head to style and enhance rendered content.
• Layout Manipulators - Provides dynamic control over pagination and viewport scaling through the injection of stylesheets and DOM manipulation.

Star history