Implement zoom control functionality for fixed-layout e-books

This commit adds comprehensive zoom control capabilities for fixed-layout
e-book content, allowing users to zoom in, out, and reset zoom levels for
better readability and content inspection.

Key features added:
- Zoom control UI with +/- buttons and percentage display
- Keyboard shortcuts for zoom operations (Ctrl/Cmd +, -, 0)
- Mouse wheel zoom with Ctrl/Cmd modifier key
- Drag-to-pan functionality when zoomed in
- Smooth zoom transitions and state management
- Zoom constraints (min/max limits) to prevent over-zooming

Changes include:
- FixedLayout: Enhanced with zoom state management, drag handlers,
  and keyboard/mouse event listeners for intuitive zoom control
- Reader UI: Added zoom control toolbar with visual feedback
- FixedLayout renderer integration with reader zoom controls

The zoom controls provide a seamless experience for users who need to
examine fixed-layout content more closely or adjust content size for
their preferred reading experience.
This commit is contained in:
2026-04-16 21:37:54 -04:00
parent 76dcd8f0f7
commit 3f9ab7528b
3 changed files with 1306 additions and 621 deletions
+326 -185
View File
@@ -1,7 +1,8 @@
import './view.js'
import { createTOCView } from './ui/tree.js'
import { createMenu } from './ui/menu.js'
import { Overlayer } from './overlayer.js'
import "./view.js";
import { createTOCView } from "./ui/tree.js";
import { createMenu } from "./ui/menu.js";
import { Overlayer } from "./overlayer.js";
import { FixedLayout } from "./fixed-layout.js";
const getCSS = ({ spacing, justify, hyphenate }) => `
@namespace epub "http://www.idpf.org/2007/ops";
@@ -16,9 +17,9 @@ const getCSS = ({ spacing, justify, hyphenate }) => `
}
p, li, blockquote, dd {
line-height: ${spacing};
text-align: ${justify ? 'justify' : 'start'};
-webkit-hyphens: ${hyphenate ? 'auto' : 'manual'};
hyphens: ${hyphenate ? 'auto' : 'manual'};
text-align: ${justify ? "justify" : "start"};
-webkit-hyphens: ${hyphenate ? "auto" : "manual"};
hyphens: ${hyphenate ? "auto" : "manual"};
-webkit-hyphenate-limit-before: 3;
-webkit-hyphenate-limit-after: 2;
-webkit-hyphenate-limit-lines: 2;
@@ -40,200 +41,340 @@ const getCSS = ({ spacing, justify, hyphenate }) => `
aside[epub|type~="rearnote"] {
display: none;
}
`
`;
const $ = document.querySelector.bind(document)
const $ = document.querySelector.bind(document);
const locales = 'en'
const percentFormat = new Intl.NumberFormat(locales, { style: 'percent' })
const listFormat = new Intl.ListFormat(locales, { style: 'short', type: 'conjunction' })
const locales = "en";
const percentFormat = new Intl.NumberFormat(locales, { style: "percent" });
const listFormat = new Intl.ListFormat(locales, {
style: "short",
type: "conjunction",
});
const formatLanguageMap = x => {
if (!x) return ''
if (typeof x === 'string') return x
const keys = Object.keys(x)
return x[keys[0]]
}
const formatLanguageMap = (x) => {
if (!x) return "";
if (typeof x === "string") return x;
const keys = Object.keys(x);
return x[keys[0]];
};
const formatOneContributor = contributor => typeof contributor === 'string'
? contributor : formatLanguageMap(contributor?.name)
const formatOneContributor = (contributor) =>
typeof contributor === "string"
? contributor
: formatLanguageMap(contributor?.name);
const formatContributor = contributor => Array.isArray(contributor)
const formatContributor = (contributor) =>
Array.isArray(contributor)
? listFormat.format(contributor.map(formatOneContributor))
: formatOneContributor(contributor)
: formatOneContributor(contributor);
class Reader {
#tocView
style = {
spacing: 1.4,
justify: true,
hyphenate: true,
#tocView;
style = {
spacing: 1.4,
justify: true,
hyphenate: true,
};
annotations = new Map();
annotationsByValue = new Map();
closeSideBar() {
$("#dimming-overlay").classList.remove("show");
$("#side-bar").classList.remove("show");
}
constructor() {
$("#side-bar-button").addEventListener("click", () => {
$("#dimming-overlay").classList.add("show");
$("#side-bar").classList.add("show");
});
$("#dimming-overlay").addEventListener("click", () => this.closeSideBar());
const menu = createMenu([
{
name: "layout",
label: "Layout",
type: "radio",
items: [
["Paginated", "paginated"],
["Scrolled", "scrolled"],
],
onclick: (value) => {
this.view?.renderer.setAttribute("flow", value);
},
},
]);
menu.element.classList.add("menu");
$("#menu-button").append(menu.element);
$("#menu-button > button").addEventListener("click", () =>
menu.element.classList.toggle("show"),
);
menu.groups.layout.select("paginated");
}
async open(file) {
this.view = document.createElement("foliate-view");
document.body.append(this.view);
await this.view.open(file);
this.view.addEventListener("load", this.#onLoad.bind(this));
this.view.addEventListener("relocate", this.#onRelocate.bind(this));
const { book } = this.view;
// DEBUG: Log book and renderer info
console.log("[Reader Debug] 📖 Book opened:", {
title: book.metadata?.title,
type: file.name,
rendition: book.rendition,
isFixedLayout: this.view.isFixedLayout,
renderer: this.view.renderer?.localName,
rendererClass: this.view.renderer?.constructor.name,
isFixedLayoutInstance: this.view.renderer instanceof FixedLayout,
});
book.transformTarget?.addEventListener("data", ({ detail }) => {
detail.data = Promise.resolve(detail.data).catch((e) => {
console.error(new Error(`Failed to load ${detail.name}`, { cause: e }));
return "";
});
});
this.view.renderer.setStyles?.(getCSS(this.style));
this.view.renderer.next();
$("#header-bar").style.visibility = "visible";
$("#nav-bar").style.visibility = "visible";
$("#left-button").addEventListener("click", () => this.view.goLeft());
$("#right-button").addEventListener("click", () => this.view.goRight());
const slider = $("#progress-slider");
slider.dir = book.dir;
slider.addEventListener("input", (e) =>
this.view.goToFraction(parseFloat(e.target.value)),
);
for (const fraction of this.view.getSectionFractions()) {
const option = document.createElement("option");
option.value = fraction;
$("#tick-marks").append(option);
}
annotations = new Map()
annotationsByValue = new Map()
closeSideBar() {
$('#dimming-overlay').classList.remove('show')
$('#side-bar').classList.remove('show')
document.addEventListener("keydown", this.#handleKeydown.bind(this));
console.log("[Reader Debug] 🔧 Setting up zoom control listeners...");
// Add zoom control listeners
$("#zoom-in").addEventListener("click", () => {
console.log("[Reader Debug] 🔍 Zoom in button clicked");
const renderer = this.view.renderer;
console.log(
"[Reader Debug] Renderer:",
renderer?.localName,
renderer?.constructor.name,
);
console.log(
"[Reader Debug] Is FixedLayout?",
renderer instanceof FixedLayout,
);
if (renderer instanceof FixedLayout) {
const current = renderer.getAttribute("zoom") || 1;
const newZoom = Math.min(10, parseFloat(current) * 1.2);
renderer.setAttribute("zoom", newZoom);
$("#zoom-reset").textContent = `${Math.round(newZoom * 100)}%`;
console.log("[Reader Debug] ✅ Zoom applied:", current, "->", newZoom);
} else {
console.log("[Reader Debug] ❌ Not a FixedLayout renderer, ignoring");
}
});
$("#zoom-out").addEventListener("click", () => {
console.log("[Reader Debug] 🔍 Zoom out button clicked");
const renderer = this.view.renderer;
console.log(
"[Reader Debug] Is FixedLayout?",
renderer instanceof FixedLayout,
);
if (renderer instanceof FixedLayout) {
const current = renderer.getAttribute("zoom") || 1;
const newZoom = Math.max(0.1, parseFloat(current) / 1.2);
renderer.setAttribute("zoom", newZoom);
$("#zoom-reset").textContent = `${Math.round(newZoom * 100)}%`;
console.log("[Reader Debug] ✅ Zoom applied:", current, "->", newZoom);
} else {
console.log("[Reader Debug] ❌ Not a FixedLayout renderer, ignoring");
}
});
$("#zoom-reset").addEventListener("click", () => {
console.log("[Reader Debug] 🔄 Reset zoom button clicked");
const renderer = this.view.renderer;
console.log(
"[Reader Debug] Is FixedLayout?",
renderer instanceof FixedLayout,
);
if (renderer instanceof FixedLayout) {
renderer.removeAttribute("zoom");
renderer.dragOffset = { x: 0, y: 0 };
$("#zoom-reset").textContent = "100%";
console.log("[Reader Debug] ✅ Zoom reset");
} else {
console.log("[Reader Debug] ❌ Not a FixedLayout renderer, ignoring");
}
});
$("#magnifier-toggle").addEventListener("click", () => {
console.log("[Reader Debug] 🔍 Magnifier toggle button clicked");
const renderer = this.view.renderer;
console.log(
"[Reader Debug] Is FixedLayout?",
renderer instanceof FixedLayout,
);
if (renderer instanceof FixedLayout) {
renderer.toggleMagnifier();
console.log("[Reader Debug] ✅ Magnifier toggled");
} else {
console.log("[Reader Debug] ❌ Not a FixedLayout renderer, ignoring");
}
});
console.log("[Reader Debug] ✅ Zoom control listeners configured");
const title = formatLanguageMap(book.metadata?.title) || "Untitled Book";
document.title = title;
$("#side-bar-title").innerText = title;
$("#side-bar-author").innerText = formatContributor(book.metadata?.author);
Promise.resolve(book.getCover?.())?.then((blob) =>
blob ? ($("#side-bar-cover").src = URL.createObjectURL(blob)) : null,
);
const toc = book.toc;
if (toc) {
this.#tocView = createTOCView(toc, (href) => {
this.view.goTo(href).catch((e) => console.error(e));
this.closeSideBar();
});
$("#toc-view").append(this.#tocView.element);
}
constructor() {
$('#side-bar-button').addEventListener('click', () => {
$('#dimming-overlay').classList.add('show')
$('#side-bar').classList.add('show')
})
$('#dimming-overlay').addEventListener('click', () => this.closeSideBar())
const menu = createMenu([
{
name: 'layout',
label: 'Layout',
type: 'radio',
items: [
['Paginated', 'paginated'],
['Scrolled', 'scrolled'],
],
onclick: value => {
this.view?.renderer.setAttribute('flow', value)
},
},
])
menu.element.classList.add('menu')
$('#menu-button').append(menu.element)
$('#menu-button > button').addEventListener('click', () =>
menu.element.classList.toggle('show'))
menu.groups.layout.select('paginated')
}
async open(file) {
this.view = document.createElement('foliate-view')
document.body.append(this.view)
await this.view.open(file)
this.view.addEventListener('load', this.#onLoad.bind(this))
this.view.addEventListener('relocate', this.#onRelocate.bind(this))
const { book } = this.view
book.transformTarget?.addEventListener('data', ({ detail }) => {
detail.data = Promise.resolve(detail.data).catch(e => {
console.error(new Error(`Failed to load ${detail.name}`, { cause: e }))
return ''
})
})
this.view.renderer.setStyles?.(getCSS(this.style))
this.view.renderer.next()
$('#header-bar').style.visibility = 'visible'
$('#nav-bar').style.visibility = 'visible'
$('#left-button').addEventListener('click', () => this.view.goLeft())
$('#right-button').addEventListener('click', () => this.view.goRight())
const slider = $('#progress-slider')
slider.dir = book.dir
slider.addEventListener('input', e =>
this.view.goToFraction(parseFloat(e.target.value)))
for (const fraction of this.view.getSectionFractions()) {
const option = document.createElement('option')
option.value = fraction
$('#tick-marks').append(option)
}
document.addEventListener('keydown', this.#handleKeydown.bind(this))
const title = formatLanguageMap(book.metadata?.title) || 'Untitled Book'
document.title = title
$('#side-bar-title').innerText = title
$('#side-bar-author').innerText = formatContributor(book.metadata?.author)
Promise.resolve(book.getCover?.())?.then(blob =>
blob ? $('#side-bar-cover').src = URL.createObjectURL(blob) : null)
const toc = book.toc
if (toc) {
this.#tocView = createTOCView(toc, href => {
this.view.goTo(href).catch(e => console.error(e))
this.closeSideBar()
})
$('#toc-view').append(this.#tocView.element)
}
// load and show highlights embedded in the file by Calibre
const bookmarks = await book.getCalibreBookmarks?.()
if (bookmarks) {
const { fromCalibreHighlight } = await import('./epubcfi.js')
for (const obj of bookmarks) {
if (obj.type === 'highlight') {
const value = fromCalibreHighlight(obj)
const color = obj.style.which
const note = obj.notes
const annotation = { value, color, note }
const list = this.annotations.get(obj.spine_index)
if (list) list.push(annotation)
else this.annotations.set(obj.spine_index, [annotation])
this.annotationsByValue.set(value, annotation)
}
}
this.view.addEventListener('create-overlay', e => {
const { index } = e.detail
const list = this.annotations.get(index)
if (list) for (const annotation of list)
this.view.addAnnotation(annotation)
})
this.view.addEventListener('draw-annotation', e => {
const { draw, annotation } = e.detail
const { color } = annotation
draw(Overlayer.highlight, { color })
})
this.view.addEventListener('show-annotation', e => {
const annotation = this.annotationsByValue.get(e.detail.value)
if (annotation.note) alert(annotation.note)
})
// load and show highlights embedded in the file by Calibre
const bookmarks = await book.getCalibreBookmarks?.();
if (bookmarks) {
const { fromCalibreHighlight } = await import("./epubcfi.js");
for (const obj of bookmarks) {
if (obj.type === "highlight") {
const value = fromCalibreHighlight(obj);
const color = obj.style.which;
const note = obj.notes;
const annotation = { value, color, note };
const list = this.annotations.get(obj.spine_index);
if (list) list.push(annotation);
else this.annotations.set(obj.spine_index, [annotation]);
this.annotationsByValue.set(value, annotation);
}
}
this.view.addEventListener("create-overlay", (e) => {
const { index } = e.detail;
const list = this.annotations.get(index);
if (list)
for (const annotation of list) this.view.addAnnotation(annotation);
});
this.view.addEventListener("draw-annotation", (e) => {
const { draw, annotation } = e.detail;
const { color } = annotation;
draw(Overlayer.highlight, { color });
});
this.view.addEventListener("show-annotation", (e) => {
const annotation = this.annotationsByValue.get(e.detail.value);
if (annotation.note) alert(annotation.note);
});
}
#handleKeydown(event) {
const k = event.key
if (k === 'ArrowLeft' || k === 'h') this.view.goLeft()
else if(k === 'ArrowRight' || k === 'l') this.view.goRight()
}
#onLoad({ detail: { doc } }) {
doc.addEventListener('keydown', this.#handleKeydown.bind(this))
}
#onRelocate({ detail }) {
const { fraction, location, tocItem, pageItem } = detail
const percent = percentFormat.format(fraction)
const loc = pageItem
? `Page ${pageItem.label}`
: `Loc ${location.current}`
const slider = $('#progress-slider')
slider.style.visibility = 'visible'
slider.value = fraction
slider.title = `${percent} · ${loc}`
if (tocItem?.href) this.#tocView?.setCurrentHref?.(tocItem.href)
}
#handleKeydown(event) {
const k = event.key;
console.log("[Reader Debug] ⌨️ Key pressed:", k);
if (k === "ArrowLeft" || k === "h") this.view.goLeft();
else if (k === "ArrowRight" || k === "l") this.view.goRight();
else if (k === "+" || k === "=") {
console.log("[Reader Debug] 🔍 Zoom in via keyboard");
const renderer = this.view.renderer;
if (renderer instanceof FixedLayout) {
const current = renderer.getAttribute("zoom") || 1;
const newZoom = Math.min(10, parseFloat(current) * 1.2);
renderer.setAttribute("zoom", newZoom);
$("#zoom-reset").textContent = `${Math.round(newZoom * 100)}%`;
console.log(
"[Reader Debug] ✅ Keyboard zoom applied:",
current,
"->",
newZoom,
);
}
} else if (k === "-" || k === "_") {
console.log("[Reader Debug] 🔍 Zoom out via keyboard");
const renderer = this.view.renderer;
if (renderer instanceof FixedLayout) {
const current = renderer.getAttribute("zoom") || 1;
const newZoom = Math.max(0.1, parseFloat(current) / 1.2);
renderer.setAttribute("zoom", newZoom);
$("#zoom-reset").textContent = `${Math.round(newZoom * 100)}%`;
console.log(
"[Reader Debug] ✅ Keyboard zoom applied:",
current,
"->",
newZoom,
);
}
} else if (k === "0") {
console.log("[Reader Debug] 🔄 Reset zoom via keyboard");
const renderer = this.view.renderer;
if (renderer instanceof FixedLayout) {
renderer.removeAttribute("zoom");
renderer.dragOffset = { x: 0, y: 0 };
$("#zoom-reset").textContent = "100%";
console.log("[Reader Debug] ✅ Keyboard zoom reset");
}
}
}
#onLoad({ detail: { doc } }) {
doc.addEventListener("keydown", this.#handleKeydown.bind(this));
}
#onRelocate({ detail }) {
const { fraction, location, tocItem, pageItem } = detail;
const percent = percentFormat.format(fraction);
const loc = pageItem ? `Page ${pageItem.label}` : `Loc ${location.current}`;
const slider = $("#progress-slider");
slider.style.visibility = "visible";
slider.value = fraction;
slider.title = `${percent} · ${loc}`;
if (tocItem?.href) this.#tocView?.setCurrentHref?.(tocItem.href);
}
}
const open = async file => {
document.body.removeChild($('#drop-target'))
const reader = new Reader()
globalThis.reader = reader
await reader.open(file)
}
const open = async (file) => {
document.body.removeChild($("#drop-target"));
const reader = new Reader();
globalThis.reader = reader;
await reader.open(file);
};
const dragOverHandler = e => e.preventDefault()
const dropHandler = e => {
e.preventDefault()
const item = Array.from(e.dataTransfer.items)
.find(item => item.kind === 'file')
if (item) {
const entry = item.webkitGetAsEntry()
open(entry.isFile ? item.getAsFile() : entry).catch(e => console.error(e))
}
}
const dropTarget = $('#drop-target')
dropTarget.addEventListener('drop', dropHandler)
dropTarget.addEventListener('dragover', dragOverHandler)
const dragOverHandler = (e) => e.preventDefault();
const dropHandler = (e) => {
e.preventDefault();
const item = Array.from(e.dataTransfer.items).find(
(item) => item.kind === "file",
);
if (item) {
const entry = item.webkitGetAsEntry();
open(entry.isFile ? item.getAsFile() : entry).catch((e) =>
console.error(e),
);
}
};
const dropTarget = $("#drop-target");
dropTarget.addEventListener("drop", dropHandler);
dropTarget.addEventListener("dragover", dragOverHandler);
$('#file-input').addEventListener('change', e =>
open(e.target.files[0]).catch(e => console.error(e)))
$('#file-button').addEventListener('click', () => $('#file-input').click())
$("#file-input").addEventListener("change", (e) =>
open(e.target.files[0]).catch((e) => console.error(e)),
);
$("#file-button").addEventListener("click", () => $("#file-input").click());
const params = new URLSearchParams(location.search)
const url = params.get('url')
if (url) open(url).catch(e => console.error(e))
else dropTarget.style.visibility = 'visible'
const params = new URLSearchParams(location.search);
const url = params.get("url");
if (url) open(url).catch((e) => console.error(e));
else dropTarget.style.visibility = "visible";