Bookhoard/foliate-js
1
0
Fork 0
mirror of https://github.com/john-okeefe/foliate-js.git synced 2026-09-09 11:29:14 -04:00
Code Issues Packages Projects Releases Wiki Activity
323 Commits 3 Branches 0 Tags
panel-detection
Commit Graph
38 Commits
Author SHA1 Message Date
john-okeefe 0926428192 docs: add comprehensive panel detection documentation 
Document the new panel detection feature with detailed explanations
of functionality, requirements, and usage.

New documentation sections:
- How It Works: Explains three-tier fallback system
  * Tier 1: OpenCV edge detection (fast, accurate)
  * Tier 2: COCO-SSD ML detection (handles irregular layouts)
  * Tier 3: Grid-based detection (lightweight, always works)

- Content Security Policy (CSP) Requirements:
  * Documents 'unsafe-eval' requirement for OpenCV.js
  * Explains why it's safe for ebook reading context
  * Provides example CSP configuration

- Usage: Complete API examples showing:
  * How to enable panel mode
  * Navigation methods (nextPanel, prevPanel)
  * Panel information properties (panelCount, currentPanelIndex)

- Keyboard Shortcuts: Available shortcuts for demo reader
  * P: Toggle panel mode
  * Arrow keys/h/l: Navigate panels
  * Escape: Exit panel mode

- Technical Details:
  * Vendored library sizes and sources
  * Dynamic loading strategy
  * UMD/global build approach for browser compatibility

- Browser Compatibility:
  * Minimum versions (Chromium 90+, Firefox 88+, Safari 15+)
  * Graceful degradation on older browsers

Updated Features section to reflect:
- Panel detection now included with vendored libraries
- Total vendor size: ~25MB (was 13MB, added 12.5MB)
 2026-04-13 19:15:06 -04:00
john-okeefe dc894c89dd Add panel detection documentation to README 
Document the new panel detection feature for manga and comics,
including installation options and usage examples.

Changes to README.md:
- Added "Optional panel detection for manga and comics" to Features list
- Added new "Panel Detection" section after "PDF and Other Fixed-Layout Formats"
- Documented the optionalDependencies approach and --omit=optional flag
- Explained the multi-tier fallback system (OpenCV → ML → Grid)
- Provided code examples for enabling panel mode and navigation
- Documented keyboard shortcuts (P, Arrow keys, Escape)
- Clarified graceful degradation when dependencies are missing

The documentation follows existing README patterns:
- Concise technical style
- Code examples with proper syntax
- Clear installation instructions
- Explanation of feature behavior and fallbacks

This helps users understand:
1. What panel detection is and when it's useful
2. How to install with or without the feature
3. How to use the API in their applications
4. What happens when optional dependencies aren't installed
 2026-04-13 17:00:33 -04:00
John Factotum 052123beaf Add an EventTarget for transforming the book 
And use it to do paginator-specific CSS replacements.

And use it to catch loading errors in reader.js.

Fixes #14
Closes #18
 2025-03-29 15:09:23 +08:00
John Factotum cc2882ff39 Update README.md 
Reflect the changes after 022ea7da87, and
other clarifications.
 2024-12-02 18:39:45 +08:00
John Factotum 022ea7da87 Make <foliate-view> handle opening files directly 2024-10-12 10:48:51 +08:00
Kian-Meng Ang 42ebb0aec4 Fix typos (#34) 
Found via `typos --hidden --format brief`
 2024-09-23 08:29:28 +00:00
John Factotum 541bc07b6f EPUB: redo metadata parsing 
- Support the `prefix` attribute (for the `property` attr on `<meta>`)
- Localized titles, names (including `sortAs`)
- `belongsTo`, including `calibre:series`
- `altIdentifier`, converted to URN where possible
- Remove `producer`. It's now `contributor` with `role: 'bkp'`.

NOTE: this is a breaking change if you assumed that `title` will always
be a string, `author` will always be an array, etc.
 2024-09-18 11:28:08 +08:00
John Factotum 0b9fac8ff3 Add module for generating quote images 2024-09-11 14:12:27 +08:00
John Factotum 8c378d68fc README: fix warning formatting 
Also add link to https://github.com/johnfactotum/epub-test
 2024-05-17 05:10:55 +00:00
John Factotum b7ff640943 Paginator: prevent spread in portrait 
Or, for vertical writing, in landscape
 2024-04-27 16:14:36 +08:00
John Factotum 1ff2d530c4 Add support for dictd and StarDict dictionaries 2023-12-16 15:04:43 +08:00
John Factotum ad5ec4d0e9 Add OPDS 2023-12-16 14:45:05 +08:00
John Factotum cbe9e0009c Make animation setting an attribute instead of a property 2023-11-28 11:07:56 +08:00
John Factotum 0d09ca12a2 EPUB: fix subjects 
Also update README
 2023-10-24 17:25:46 +08:00
John Factotum a63a68eda0 Add PDF support 2023-10-08 21:27:06 +08:00
John Factotum 27a290ff59 Allow processing hrefs in TOC asynchronously 2023-10-08 20:42:47 +08:00
John Factotum 83cce01797 Make text walker a separate module 2023-10-01 18:19:13 +08:00
John Factotum cea9375561 CFI: add ability to ignore nodes 
Also test that comment nodes are ignore
 2023-09-29 23:58:55 +08:00
John Factotum d5d1541d3b Paginator: use CSS grid 
Massively simplify margin/padding and header/footer layout and eliminate
unnecessary resizes and resize loops.

Also remove layout and style API from View, as these are only applicable
to the paginator.
 2023-05-28 22:17:56 +08:00
John Factotum 4fd56e7a3c Update README.md 2023-05-18 23:41:32 +08:00
John Factotum 8d69473e1f Fix README.md 2023-05-15 12:11:04 +00:00
John Factotum 0a3f4b8f27 Use Shadow DOM 2023-05-15 20:00:35 +08:00
John Factotum 4acfc050ea Turn View into a custom element, and use DOM events 
Also change "relocated" -> "relocate"
 2023-05-15 15:27:18 +08:00
John Factotum a817932b08 Update README.md 2023-05-03 17:33:37 +08:00
John Factotum 34973ac032 Update README.md 2023-03-30 17:23:20 +08:00
John Factotum c85aeafe99 Documentation: more detailed overview 2023-03-15 04:36:43 +00:00
John Factotum 2a5ccb93d9 Reader: allow opening unzipped EPUBs 2022-10-27 17:41:26 +00:00
John Factotum 967a00f5b8 Make paginator more self-contained 
Don't rely on absolute positioning and margin. And set background on
the containing element rather than the document body.
 2022-10-27 09:05:29 +00:00
John Factotum d63905346c Add annotations 
Simplify overlayer API; allow one overlayer only.
 2022-10-24 13:11:51 +00:00
John Factotum c3598e3c38 Update README.md 2022-10-22 14:17:14 +00:00
John Factotum bf9a2699e0 Update README.md 2022-10-21 23:33:56 +00:00
John Factotum 759a3b31a7 Fix vertical writing for Firefox 2022-10-20 15:30:49 +00:00
John Factotum cf9d4cb8a5 Update README.md 2022-10-20 09:32:00 +00:00
John Factotum 2dc424de29 Update README.md 2022-10-19 20:13:03 +00:00
John Factotum 3ac917c706 Add tests for EPUB CFI 2022-10-19 17:03:49 +00:00
John Factotum 8ca6bd5f29 Update README.md 2022-10-19 12:19:51 +00:00
John Factotum 1d1b5ed82b Update README.md 2022-10-18 19:39:47 +00:00
John Factotum c986ba68e5 Initial commit 2022-10-18 18:45:22 +00:00