@openpageflip/core 0.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Ben Honda and OpenPageFlip contributors
+Copyright (c) 2020 Oleg Litovski (StPageFlip and react-pageflip, from which the page-fold geometry is derived)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @openpageflip/core
+
+Framework-agnostic page-turn engine. Successor to [`page-flip`](https://www.npmjs.com/package/page-flip) (StPageFlip).
+
+Pre-1.0 and under construction. The plan, decisions and status live in the
+[repository's SPEC.md](https://github.com/benhonda/openpageflip/blob/main/SPEC.md).
+
+```sh
+bun add @openpageflip/core
+```
+
+```ts
+import "@openpageflip/core/styles.css";
+import { Layout } from "@openpageflip/core";
+```
+
+A CDN build is published as `dist/index.iife.js` and exposes `window.OpenPageFlip`.

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+//#region src/options.d.ts
+/**
+ * Public option vocabularies. Plain `as const` objects instead of enums so they survive
+ * `isolatedModules`, `erasableSyntaxOnly`, and consumers who only speak string literals.
+ */
+/** How many pages are visible at once. `auto` picks by container width. */
+declare const Layout: {
+  readonly auto: "auto";
+  readonly single: "single";
+  readonly spread: "spread";
+};
+type Layout = (typeof Layout)[keyof typeof Layout];
+/** Reading direction. `rtl` flips the spine to the right for manga and Hebrew/Arabic books. */
+declare const Direction: {
+  readonly ltr: "ltr";
+  readonly rtl: "rtl";
+};
+type Direction = (typeof Direction)[keyof typeof Direction];
+/** Which corner a programmatic flip lifts. */
+declare const FlipCorner: {
+  readonly top: "top";
+  readonly bottom: "bottom";
+};
+type FlipCorner = (typeof FlipCorner)[keyof typeof FlipCorner];
+/** `hard` pages rotate as a rigid sheet (covers); `soft` pages bend along the fold. */
+declare const PageDensity: {
+  readonly soft: "soft";
+  readonly hard: "hard";
+};
+type PageDensity = (typeof PageDensity)[keyof typeof PageDensity];
+//#endregion
+export { Direction, FlipCorner, Layout, PageDensity };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.iife.js

@@ -0,0 +1,37 @@
+var OpenPageFlip = (function(exports) {
+	Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+	//#region src/options.ts
+	/**
+	* Public option vocabularies. Plain `as const` objects instead of enums so they survive
+	* `isolatedModules`, `erasableSyntaxOnly`, and consumers who only speak string literals.
+	*/
+	/** How many pages are visible at once. `auto` picks by container width. */
+	const Layout = {
+		auto: "auto",
+		single: "single",
+		spread: "spread"
+	};
+	/** Reading direction. `rtl` flips the spine to the right for manga and Hebrew/Arabic books. */
+	const Direction = {
+		ltr: "ltr",
+		rtl: "rtl"
+	};
+	/** Which corner a programmatic flip lifts. */
+	const FlipCorner = {
+		top: "top",
+		bottom: "bottom"
+	};
+	/** `hard` pages rotate as a rigid sheet (covers); `soft` pages bend along the fold. */
+	const PageDensity = {
+		soft: "soft",
+		hard: "hard"
+	};
+	//#endregion
+	exports.Direction = Direction;
+	exports.FlipCorner = FlipCorner;
+	exports.Layout = Layout;
+	exports.PageDensity = PageDensity;
+	return exports;
+})({});
+
+//# sourceMappingURL=index.iife.js.map

package/dist/index.iife.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.iife.js","names":[],"sources":["../src/options.ts"],"sourcesContent":["/**\n * Public option vocabularies. Plain `as const` objects instead of enums so they survive\n * `isolatedModules`, `erasableSyntaxOnly`, and consumers who only speak string literals.\n */\n\n/** How many pages are visible at once. `auto` picks by container width. */\nexport const Layout = { auto: \"auto\", single: \"single\", spread: \"spread\" } as const;\nexport type Layout = (typeof Layout)[keyof typeof Layout];\n\n/** Reading direction. `rtl` flips the spine to the right for manga and Hebrew/Arabic books. */\nexport const Direction = { ltr: \"ltr\", rtl: \"rtl\" } as const;\nexport type Direction = (typeof Direction)[keyof typeof Direction];\n\n/** Which corner a programmatic flip lifts. */\nexport const FlipCorner = { top: \"top\", bottom: \"bottom\" } as const;\nexport type FlipCorner = (typeof FlipCorner)[keyof typeof FlipCorner];\n\n/** `hard` pages rotate as a rigid sheet (covers); `soft` pages bend along the fold. */\nexport const PageDensity = { soft: \"soft\", hard: \"hard\" } as const;\nexport type PageDensity = (typeof PageDensity)[keyof typeof PageDensity];\n"],"mappings":";;;;;;;;CAMA,MAAa,SAAS;EAAE,MAAM;EAAQ,QAAQ;EAAU,QAAQ;CAAS;;CAIzE,MAAa,YAAY;EAAE,KAAK;EAAO,KAAK;CAAM;;CAIlD,MAAa,aAAa;EAAE,KAAK;EAAO,QAAQ;CAAS;;CAIzD,MAAa,cAAc;EAAE,MAAM;EAAQ,MAAM;CAAO"}

package/dist/index.js

@@ -0,0 +1,30 @@
+//#region src/options.ts
+/**
+* Public option vocabularies. Plain `as const` objects instead of enums so they survive
+* `isolatedModules`, `erasableSyntaxOnly`, and consumers who only speak string literals.
+*/
+/** How many pages are visible at once. `auto` picks by container width. */
+const Layout = {
+	auto: "auto",
+	single: "single",
+	spread: "spread"
+};
+/** Reading direction. `rtl` flips the spine to the right for manga and Hebrew/Arabic books. */
+const Direction = {
+	ltr: "ltr",
+	rtl: "rtl"
+};
+/** Which corner a programmatic flip lifts. */
+const FlipCorner = {
+	top: "top",
+	bottom: "bottom"
+};
+/** `hard` pages rotate as a rigid sheet (covers); `soft` pages bend along the fold. */
+const PageDensity = {
+	soft: "soft",
+	hard: "hard"
+};
+//#endregion
+export { Direction, FlipCorner, Layout, PageDensity };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/options.ts"],"sourcesContent":["/**\n * Public option vocabularies. Plain `as const` objects instead of enums so they survive\n * `isolatedModules`, `erasableSyntaxOnly`, and consumers who only speak string literals.\n */\n\n/** How many pages are visible at once. `auto` picks by container width. */\nexport const Layout = { auto: \"auto\", single: \"single\", spread: \"spread\" } as const;\nexport type Layout = (typeof Layout)[keyof typeof Layout];\n\n/** Reading direction. `rtl` flips the spine to the right for manga and Hebrew/Arabic books. */\nexport const Direction = { ltr: \"ltr\", rtl: \"rtl\" } as const;\nexport type Direction = (typeof Direction)[keyof typeof Direction];\n\n/** Which corner a programmatic flip lifts. */\nexport const FlipCorner = { top: \"top\", bottom: \"bottom\" } as const;\nexport type FlipCorner = (typeof FlipCorner)[keyof typeof FlipCorner];\n\n/** `hard` pages rotate as a rigid sheet (covers); `soft` pages bend along the fold. */\nexport const PageDensity = { soft: \"soft\", hard: \"hard\" } as const;\nexport type PageDensity = (typeof PageDensity)[keyof typeof PageDensity];\n"],"mappings":";;;;;;AAMA,MAAa,SAAS;CAAE,MAAM;CAAQ,QAAQ;CAAU,QAAQ;AAAS;;AAIzE,MAAa,YAAY;CAAE,KAAK;CAAO,KAAK;AAAM;;AAIlD,MAAa,aAAa;CAAE,KAAK;CAAO,QAAQ;AAAS;;AAIzD,MAAa,cAAc;CAAE,MAAM;CAAQ,MAAM;AAAO"}

package/dist/styles.css

@@ -0,0 +1,22 @@
+/*
+ * @openpageflip/core stylesheet. Import it once: `import "@openpageflip/core/styles.css"`.
+ * Theming is through the custom properties below; set them on the host element.
+ */
+.opf-book {
+  --opf-flip-duration: 800ms;
+  --opf-shadow-opacity: 1;
+
+  position: relative;
+  display: block;
+  box-sizing: border-box;
+  /* Vertical page scroll stays native; horizontal drags belong to the book. */
+  touch-action: pan-y;
+  user-select: none;
+  -webkit-user-select: none;
+}
+
+@media (prefers-reduced-motion: reduce) {
+  .opf-book {
+    --opf-flip-duration: 0ms;
+  }
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@openpageflip/core",
+  "version": "0.0.0",
+  "description": "Realistic page-flip effect for HTML content. Framework-agnostic successor to StPageFlip.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/benhonda/openpageflip.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/benhonda/openpageflip#readme",
+  "bugs": "https://github.com/benhonda/openpageflip/issues",
+  "keywords": [
+    "page-flip",
+    "flipbook",
+    "book",
+    "page turn",
+    "stpageflip",
+    "typescript"
+  ],
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./styles.css": "./dist/styles.css",
+    "./package.json": "./package.json"
+  },
+  "unpkg": "./dist/index.iife.js",
+  "jsdelivr": "./dist/index.iife.js"
+}