@zinejs/core 0.9.0 → 0.9.2

package/LICENSE

@@ -0,0 +1,73 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/dist/controls/icons.d.ts

@@ -46,6 +46,10 @@ export declare const ICONS: {
     download: string;
     /** x */
     close: string;
+    /** volume-2: sound on */
+    soundOn: string;
+    /** volume-x: muted */
+    soundOff: string;
 };
 /** Build an `<svg>` for one of the {@link ICONS}, or null if the name is unknown. */
 export declare function createIcon(doc: Document, markup: string): SVGSVGElement;

package/dist/controls/sidebar.d.ts

@@ -46,6 +46,8 @@ export declare class Sidebar {
          *  than the whole container, which is taller whenever the page is letterboxed (its aspect not
          *  matching the container's) or a docked toolbar padded the wrap. Re-read on every resize. */
         pageBox?: () => PageBox | null;
+        /** aria-label for the drawer's close button. Defaults to 'Close'. */
+        closeLabel?: string;
     });
     /** Resize the rail, e.g. once a thumbnail list knows whether it needs one column or two. */
     setWidth(px: number): void;

package/dist/controls/types.d.ts

@@ -1,4 +1,5 @@
 import type { Zine } from '../zine';
+import type { ZineStrings } from '../strings';
 /** Where the toolbar sits relative to the book. */
 export type ControlsPosition = 'top' | 'bottom' | 'left' | 'right';
 /** How the controls decide between their light and dark palettes. */
@@ -12,6 +13,8 @@ export interface ControlContext {
     /** The controls' resolved colour scheme, for a control that mounts its own root outside the
      *  toolbar (the share dialog) and so has to carry the scheme across to it. */
     readonly colorScheme: ControlsColorScheme;
+    /** Resolved reader-facing text (English defaults merged with the `strings` option). */
+    readonly strings: ZineStrings;
 }
 /**
  * One button in the toolbar.

package/dist/{controls-CcOu_19g.js → controls-Dh1okIx6.js}

@@ -1,17 +1,17 @@
 import { i as e, n as t, r as n, t as r } from "./registry-5nuYFMd4.js";
-import { i, n as a, r as o, t as s } from "./styles-D_zOGk2q.js";
+import { i, n as a, r as o, t as s } from "./styles-C1Qp5pby.js";
 //#region src/controls/builtins.ts
 var c = Math.SQRT2, l = (e) => e.zine.container.ownerDocument?.fullscreenElement === e.zine.container;
 function u() {
 	t({
 		id: "prev",
-		title: "Previous page",
+		title: (e) => e.strings.prevPage,
 		icon: o.prev,
 		isDisabled: (e) => !e.zine.canFlipPrev(),
 		action: (e) => e.zine.flipPrev()
 	}), t({
 		id: "next",
-		title: "Next page",
+		title: (e) => e.strings.nextPage,
 		icon: o.next,
 		isDisabled: (e) => !e.zine.canFlipNext(),
 		action: (e) => e.zine.flipNext()
@@ -19,7 +19,7 @@ function u() {
 	let e = (e) => e.zine.getDirection() === "rtl";
 	t({
 		id: "first",
-		title: "First page",
+		title: (e) => e.strings.firstPage,
 		icon: (t) => e(t) ? o.last : o.first,
 		isDisabled: (e) => !e.zine.canFlipPrev(),
 		action: (e) => {
@@ -27,7 +27,7 @@ function u() {
 		}
 	}), t({
 		id: "last",
-		title: "Last page",
+		title: (e) => e.strings.lastPage,
 		icon: (t) => e(t) ? o.first : o.last,
 		isDisabled: (e) => !e.zine.canFlipNext(),
 		action: (e) => {
@@ -35,19 +35,19 @@ function u() {
 		}
 	}), t({
 		id: "zoomIn",
-		title: "Zoom in",
+		title: (e) => e.strings.zoomIn,
 		icon: o.zoomIn,
 		isDisabled: (e) => e.zine.getZoom() >= e.zine.getMaxZoom() - 1e-6,
 		action: (e) => e.zine.setZoom(e.zine.getZoom() * c)
 	}), t({
 		id: "zoomOut",
-		title: "Zoom out",
+		title: (e) => e.strings.zoomOut,
 		icon: o.zoomOut,
 		isDisabled: (e) => e.zine.getZoom() <= 1.000001,
 		action: (e) => e.zine.setZoom(e.zine.getZoom() / c)
 	}), t({
 		id: "fullscreen",
-		title: "Fullscreen",
+		title: (e) => e.strings.fullscreen,
 		icon: o.fullscreen,
 		isVisible: (e) => typeof e.zine.container.requestFullscreen == "function",
 		isActive: l,
@@ -55,18 +55,25 @@ function u() {
 			let t = e.zine.container.ownerDocument;
 			l(e) ? t?.exitFullscreen?.() : e.zine.container.requestFullscreen?.(), e.close();
 		}
+	}), t({
+		id: "mute",
+		title: (e) => e.zine.isSoundMuted() ? e.strings.unmute : e.strings.mute,
+		icon: (e) => e.zine.isSoundMuted() ? o.soundOff : o.soundOn,
+		isVisible: (e) => e.zine.isSoundEnabled(),
+		isActive: (e) => e.zine.isSoundMuted(),
+		action: (e) => e.zine.setSoundMuted(!e.zine.isSoundMuted())
 	}), t({
 		id: "share",
-		title: "Share",
+		title: (e) => e.strings.share,
 		icon: o.share,
 		action: (e) => {
-			e.close(), import("./share-BrQa6aYm.js").then(({ ShareDialog: t }) => new t(e.zine, e.zine.container, e.colorScheme)).catch(() => {
+			e.close(), import("./share-CZorhnKI.js").then(({ ShareDialog: t }) => new t(e.zine, e.zine.container, e.colorScheme)).catch(() => {
 				navigator.clipboard?.writeText(e.zine.pageLink()).catch(() => {});
 			});
 		}
 	}), t({
 		id: "download",
-		title: "Download PDF",
+		title: (e) => e.strings.downloadPdf,
 		icon: o.download,
 		isVisible: (e) => e.zine.canDownload(),
 		action: async (e) => {
@@ -74,7 +81,7 @@ function u() {
 		}
 	}), t({
 		id: "spread",
-		title: (e) => e.zine.isSinglePage() ? "Show two pages" : "Show one page",
+		title: (e) => e.zine.isSinglePage() ? e.strings.showTwoPages : e.strings.showOnePage,
 		icon: (e) => e.zine.isSinglePage() ? o.twoPages : o.onePage,
 		isVisible: (e) => !e.zine.isResponsiveSingle(),
 		action: (e) => {
@@ -82,7 +89,7 @@ function u() {
 		}
 	}), t({
 		id: "print",
-		title: "Print",
+		title: (e) => e.strings.print,
 		icon: o.print,
 		isVisible: (e) => e.zine.canPrint(),
 		action: async (e) => {
@@ -90,7 +97,7 @@ function u() {
 		}
 	}), t({
 		id: "menu",
-		title: "More",
+		title: (e) => e.strings.more,
 		icon: o.menu,
 		children: [
 			"first",
@@ -98,6 +105,7 @@ function u() {
 			"spread",
 			"thumbnails",
 			"outline",
+			"mute",
 			"print",
 			"download"
 		]
@@ -222,7 +230,7 @@ var C = class {
 			"dblclick",
 			"wheel"
 		]) this.root.addEventListener(e, (e) => e.stopPropagation());
-		this.#u(e, t, n.rtl ?? !1, n.overlay ?? !1), n.onDismiss && this.#d(e, n.onDismiss), this.#c(t);
+		this.#u(e, t, n.rtl ?? !1, n.overlay ?? !1), n.onDismiss && this.#d(e, n.onDismiss, n.closeLabel ?? "Close"), this.#c(t);
 	}
 	#c(e) {
 		this.#o && (this.#l(), !(typeof ResizeObserver > "u") && (this.#s = new ResizeObserver(() => this.#l()), this.#s.observe(e)));
@@ -242,11 +250,11 @@ var C = class {
 		let i = t.closest(".zine-controls-wrap") ?? t, a = e.createElement("div");
 		a.className = "zine-panel-wrap", n && a.classList.add("zine-panel-wrap-rtl"), r && a.classList.add("zine-panel-wrap-overlay"), i.parentNode.insertBefore(a, i), a.append(this.#e, i), this.#t = a;
 	}
-	#d(e, t) {
-		let n = e.createElement("button");
-		if (n.type = "button", n.className = "zine-panel-close", n.setAttribute("aria-label", "Close"), n.appendChild(i(e, o.close)), n.addEventListener("click", (e) => {
+	#d(e, t, n) {
+		let r = e.createElement("button");
+		if (r.type = "button", r.className = "zine-panel-close", r.setAttribute("aria-label", n), r.appendChild(i(e, o.close)), r.addEventListener("click", (e) => {
 			e.stopPropagation(), t();
-		}), this.#e.appendChild(n), this.#r = n, this.#t) {
+		}), this.#e.appendChild(r), this.#r = r, this.#t) {
 			let n = e.createElement("div");
 			n.className = "zine-panel-scrim", this.#t.insertBefore(n, this.#e);
 			for (let e of ["pointerdown", "click"]) n.addEventListener(e, (e) => {
@@ -280,7 +288,8 @@ var C = class {
 		let r = t.ownerDocument;
 		this.#t = r, this.#n = new C(r, t, {
 			className: "zine-thumbs",
-			label: "Pages",
+			label: e.strings.thumbnailsLabel,
+			closeLabel: e.strings.close,
 			width: 90,
 			onDismiss: n.onDismiss,
 			rtl: e.getDirection() === "rtl",
@@ -300,7 +309,7 @@ var C = class {
 				n.className = "zine-thumbs-cell", n.dataset.page = String(t), e.appendChild(n);
 			}
 			let o = [...a].sort((e, t) => e - t).map((e) => e + 1);
-			e.setAttribute("aria-label", o.length > 1 ? `Pages ${o[0]}–${o.at(-1)}` : `Page ${o[0] ?? ""}`);
+			e.setAttribute("aria-label", this.#e.strings.thumbnailAria(o.map(String)));
 			let s = this.#t.createElement("span");
 			s.className = "zine-thumbs-caption", s.textContent = o.join("–"), e.appendChild(s), e.addEventListener("click", () => {
 				a.length > 0 && this.#e.flipTo(Math.min(...a));
@@ -367,13 +376,14 @@ var C = class {
 		let r = t.ownerDocument;
 		this.#t = r, this.#a = n.onDismiss, this.#n = new C(r, t, {
 			className: "zine-outline",
-			label: "Outline",
+			label: e.strings.outlineLabel,
+			closeLabel: e.strings.close,
 			width: E,
 			onDismiss: n.onDismiss,
 			rtl: e.getDirection() === "rtl",
 			overlay: !0,
 			pageBox: () => e.getPageBox()
-		}), this.root = this.#n.root, this.#o("Loading…"), this.#s(), this.#i.push(e.on("pageChanged", () => this.#l()));
+		}), this.root = this.#n.root, this.#o(e.strings.outlineLoading), this.#s(), this.#i.push(e.on("pageChanged", () => this.#l()));
 	}
 	#o(e) {
 		let t = this.#t.createElement("div");
@@ -383,7 +393,7 @@ var C = class {
 		let e = await this.#e.getOutline();
 		if (this.#n.root.isConnected) {
 			if (e.length === 0) {
-				this.#o("This document has no outline.");
+				this.#o(this.#e.strings.outlineEmpty);
 				return;
 			}
 			this.#n.root.replaceChildren(), this.#c(e, 0), this.#l();
@@ -392,10 +402,12 @@ var C = class {
 	#c(e, t) {
 		for (let n of e) {
 			let e = this.#t.createElement("button");
-			if (e.type = "button", e.className = "zine-outline-row", e.setAttribute("role", "option"), e.style.paddingLeft = `${8 + t * D}px`, e.textContent = n.title, e.title = n.title, n.page === null) e.disabled = !0;
+			e.type = "button", e.className = "zine-outline-row", e.setAttribute("role", "option"), e.style.paddingLeft = `${8 + t * D}px`;
+			let r = n.title.trim() || this.#e.strings.untitled;
+			if (e.textContent = r, e.title = r, n.page === null) e.disabled = !0;
 			else {
 				let t = n.page;
-				e.setAttribute("aria-label", `${n.title}, page ${t + 1}`), e.addEventListener("click", () => {
+				e.setAttribute("aria-label", this.#e.strings.outlineEntryAria(r, t + 1)), e.addEventListener("click", () => {
 					this.#e.flipTo(t), this.#a?.();
 				}), this.#r.push({
 					el: e,
@@ -430,13 +442,14 @@ var C = class {
 		let r = t.ownerDocument;
 		this.#t = r, this.#s = n.onDismiss, this.#n = new C(r, t, {
 			className: "zine-search",
-			label: "Search results",
+			label: e.strings.searchResultsLabel,
+			closeLabel: e.strings.close,
 			width: k,
 			onDismiss: n.onDismiss,
 			rtl: e.getDirection() === "rtl",
 			overlay: !0,
 			pageBox: () => e.getPageBox()
-		}), this.root = this.#n.root, this.#r = r.createElement("input"), this.#r.type = "search", this.#r.className = "zine-search-input", this.#r.placeholder = "Search…", this.#r.setAttribute("aria-label", "Search the document"), this.#r.addEventListener("input", () => {
+		}), this.root = this.#n.root, this.#r = r.createElement("input"), this.#r.type = "search", this.#r.className = "zine-search-input", this.#r.placeholder = e.strings.searchPlaceholder, this.#r.setAttribute("aria-label", e.strings.searchInputLabel), this.#r.addEventListener("input", () => {
 			this.#o && clearTimeout(this.#o), this.#o = setTimeout(() => void this.#u(), A);
 		}), this.#r.addEventListener("keydown", (e) => {
 			e.key === "Enter" && (this.#o && clearTimeout(this.#o), this.#u());
@@ -460,20 +473,20 @@ var C = class {
 			this.#c = [], this.#i.replaceChildren();
 			return;
 		}
-		this.#l("Searching…");
+		this.#l(this.#e.strings.searching);
 		let n = await this.#e.search(e);
 		t !== this.#a || !this.#n.root.isConnected || this.#d(e, n);
 	}
 	#d(e, t) {
 		if (this.#c = t, t.length === 0) {
-			this.#l(`No matches for “${e}”`);
+			this.#l(this.#e.strings.noMatches(e));
 			return;
 		}
 		this.#i.replaceChildren(...t.map((e) => {
 			let t = this.#t.createElement("button");
-			t.type = "button", t.className = "zine-search-hit", t.setAttribute("role", "option"), t.setAttribute("aria-label", `Page ${e.page + 1}: ${e.excerpt}`);
+			t.type = "button", t.className = "zine-search-hit", t.setAttribute("role", "option"), t.setAttribute("aria-label", this.#e.strings.searchHitAria(e.page + 1, e.excerpt));
 			let n = this.#t.createElement("span");
-			n.className = "zine-search-page", n.textContent = `Page ${e.page + 1}`;
+			n.className = "zine-search-page", n.textContent = this.#e.strings.searchHitLabel(e.page + 1);
 			let r = this.#t.createElement("small");
 			return r.textContent = e.excerpt, t.append(n, r), t.addEventListener("click", () => {
 				this.#e.flipTo(e.page), this.#s?.();
@@ -493,7 +506,7 @@ var C = class {
 	constructor(e, t, n = "auto", r = null) {
 		this.#e = e, this.#i = r;
 		let i = t.ownerDocument, a = e.getDirection() === "rtl";
-		if (this.#t = this.#o(i, a ? o.next : o.prev, "Previous page", () => e.flipPrev()), this.#n = this.#o(i, a ? o.prev : o.next, "Next page", () => e.flipNext()), this.#s(i, t), this.#r) s(this.#r, n);
+		if (this.#t = this.#o(i, a ? o.next : o.prev, e.strings.prevPage, () => e.flipPrev()), this.#n = this.#o(i, a ? o.prev : o.next, e.strings.nextPage, () => e.flipNext()), this.#s(i, t), this.#r) s(this.#r, n);
 		else for (let e of [this.#t, this.#n]) s(e, n);
 		this.#a.push(e.on("pageChanged", ({ page: e }) => this.#c(e))), this.#a.push(e.on("flipEnd", () => this.#c())), this.#c();
 	}
@@ -589,7 +602,7 @@ var L = class {
 			`zine-controls-${o}`,
 			c ? "zine-controls-docked" : "zine-controls-floating",
 			n.className
-		].filter(Boolean).join(" "), this.#n.setAttribute("role", "toolbar"), this.#n.setAttribute("aria-label", "Flipbook controls"), s(this.#n, this.#h), this.#r = i.createElement("div"), this.#r.className = "zine-controls-bar", this.#n.appendChild(this.#r), this.#n.addEventListener("keydown", (e) => this.#E(e));
+		].filter(Boolean).join(" "), this.#n.setAttribute("role", "toolbar"), this.#n.setAttribute("aria-label", this.#e.strings.controlsLabel), s(this.#n, this.#h), this.#r = i.createElement("div"), this.#r.className = "zine-controls-bar", this.#n.appendChild(this.#r), this.#n.addEventListener("keydown", (e) => this.#E(e));
 		for (let e of F) this.#n.addEventListener(e, (e) => this.#y(e));
 		this.#v(t, o, c);
 		let l = () => this.#D();
@@ -632,7 +645,8 @@ var L = class {
 		return {
 			zine: this.#e,
 			close: e,
-			colorScheme: this.#h
+			colorScheme: this.#h,
+			strings: this.#e.strings
 		};
 	}
 	#x(t) {
@@ -704,9 +718,9 @@ var L = class {
 		let e = this.#t.createElement("div");
 		e.className = "zine-controls-page";
 		let t = this.#t.createElement("input");
-		t.type = "number", t.min = "1", t.max = String(this.#e.getPageCount()), t.value = String(this.#e.getPage() + 1), t.setAttribute("aria-label", "Page number");
+		t.type = "number", t.min = "1", t.max = String(this.#e.getPageCount()), t.value = String(this.#e.getPage() + 1), t.setAttribute("aria-label", this.#e.strings.pageNumberLabel);
 		let n = this.#t.createElement("span");
-		n.textContent = `/ ${this.#e.getPageCount()}`;
+		n.textContent = this.#e.strings.pageTotal(this.#e.getPageCount());
 		let r = !1, i = () => {
 			if (r) return;
 			r = !0;
@@ -747,7 +761,7 @@ var L = class {
 function R(e) {
 	u(), t({
 		id: "thumbnails",
-		title: () => e.openPanel() === "thumbnails" ? "Hide thumbnails" : "Show thumbnails",
+		title: (t) => e.openPanel() === "thumbnails" ? t.strings.hideThumbnails : t.strings.showThumbnails,
 		icon: o.thumbnails,
 		isVisible: (e) => e.zine.isDocument(),
 		isActive: () => e.openPanel() === "thumbnails",
@@ -756,7 +770,7 @@ function R(e) {
 		}
 	}), t({
 		id: "outline",
-		title: () => e.openPanel() === "outline" ? "Hide outline" : "Show outline",
+		title: (t) => e.openPanel() === "outline" ? t.strings.hideOutline : t.strings.showOutline,
 		icon: o.outline,
 		isVisible: () => e.hasOutline(),
 		isActive: () => e.openPanel() === "outline",
@@ -765,11 +779,11 @@ function R(e) {
 		}
 	}), t({
 		id: "pageInput",
-		title: "Page",
+		title: (e) => e.strings.pageWidgetLabel,
 		render: () => e.makePageInput()
 	}), t({
 		id: "search",
-		title: () => e.openPanel() === "search" ? "Hide search" : "Search",
+		title: (t) => e.openPanel() === "search" ? t.strings.searchClose : t.strings.searchOpen,
 		icon: o.search,
 		isVisible: (e) => e.zine.canSearch(),
 		isActive: () => e.openPanel() === "search",
@@ -786,6 +800,7 @@ var z = [
 	"next",
 	"|",
 	"fullscreen",
+	"mute",
 	"|",
 	"print",
 	"download",
@@ -823,12 +838,13 @@ var z = [
 		return {
 			zine: this.#e,
 			close: () => this.#d(),
-			colorScheme: this.#i
+			colorScheme: this.#i,
+			strings: this.#e.strings
 		};
 	}
 	#l(e, t) {
 		this.#d();
-		let n = new x(this.#n, () => this.#c(), () => this.#o?.refresh(), this.#a);
+		let n = new x(this.#n, () => this.#c(), () => this.#d(), this.#a);
 		if (n.build(this.#r), !n.el.querySelector("button")) return;
 		let r = this.#n.createElement("div");
 		r.className = "zine-context-layer", s(r, this.#i), r.appendChild(n.el), this.#t.appendChild(r), this.#o = n, n.refresh(), this.#u(n.el, e, t), n.focusFirst();
@@ -866,4 +882,4 @@ function U(e, t, n = {}, r = /* @__PURE__ */ new Set()) {
 //#endregion
 export { U as mountContextMenu, H as mountControls };
 
-//# sourceMappingURL=controls-CcOu_19g.js.map
+//# sourceMappingURL=controls-Dh1okIx6.js.map