@gullabs/flipbook-core

中文文档
3.2.2发布于 2026/10/01MPL-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 1万

框架-不可知的页面曲线引擎. 维护了 StPageFlip 的分叉 .

中文使用文档
文档目录3 节
  1. 要点
  2. 错误代码
  3. 许可证

@ gullabs/ flipbook- core (英语)

框架-不可知 HTML 页面曲线引擎. 维护了 StPageFlip 的分叉 . 零运行时间依赖关系. 许可证 : MPL - 2.0 导弹。 。 。 .

完整的单一目录文件(安装食谱、造型、事件、无障碍、安全部门改革/社区支助):

npm i @gullabs/flipbook-core
import { PageFlip } from '@gullabs/flipbook-core';
// Optional under a strict CSP — default is runtime style injection:
// import '@gullabs/flipbook-core/style.css';

const pageFlip = new PageFlip(root, { width: 400, height: 600 });
pageFlip.loadFromHTML(pages);
// HTML only — loadFromImages / canvas mode were removed in 3.0.0.
// Pictures: put <img alt="…"> inside the HTML page elements.

要点

专题规则
纸张颜色pageBackground (默认) #fff页:1 --stf-paper不透明是结构性的.
叶质样式 a 内 包装;发动机在叶根上拥有布局+纸张.
样式表默认注入 CSS 。 社区支助方案: injectStyles: false + 船舶 style.css 编号 : FLIPBOOK_CSS。 。 。 .
导航flipToPage 编号 : flipNext 编号 : flipPrev 动画; turnTo* 瞬间。 相对转回 boolean 并可能发射 turnRejected。 。 。 .
进展turnProgress 在折叠移动时。 安静 flippingTime: 0减少运动,并徘徊皮革。 无终端 1.0和解 flip 编号 : changeState。 。 。 .
仅反应lazyRadius, (中文(简体) ), controls, (中文(简体) ), liveRegion, (中文(简体) ), useKeyboard控件 page 编号 : pageTransition 没有 FlipOptions。未知的密钥会被忽略。 自己打开DOM.
取消cancelTurn() 不承诺而中止飞行. read 在肖像复制被移除后,在完成的转弯和取消时起火.
媒体肖像复制替换每个 <video> 带有当前框架和条纹的画布 <audio>。没有第二个请求、解码器或音频。 一个克隆人 <canvas> 未支持。 地貌折叠活性元素.
控件与 respectInteractiveContent (默认),一个开始于 video[controls], (中文(简体) ), audio[controls], (中文(简体) ), iframe, (中文(简体) ), embed,或 object 不开始折叠。 A 类 <video> 没有控制仍然刷卡.
重播核心不播放、暂停或加载创建的主机媒体。 播放从 getVisiblePages()。 。 。 .
查询getVisiblePages(), (中文(简体) ), canTurn(dir), (中文(简体) ), getPageCount(), (中文(简体) ), getCurrentPageIndex(), (中文(简体) ), isReady(), (中文(简体) ), isAnimating()。 。 。 .

错误代码

公开失败 PageFlipError 拥有稳定 code 财务报告和审定财务报表 kind (单位:千美元)usage | lifecycle | internal) (中文(简体) ). 设置失败也设定了 err.setting。 。 。 .

代码仁爱何时
INVALID_SETTING使用量设置失败验证( A)err.setting 名称
INVALID_PAGE使用量超出范围的页面索引
PAGE_NOT_IN_SPREAD使用量页面已存在,但没有扩展
INVALID_INDEX使用量内部数组访问范围外
WRONG_MODE使用量画布删除后保留; 今天不是被 HTML 抛出
DESTROYED生命周期后调用 destroy()
NOT_LOADED生命周期装入完成前使用的 API
DETACHED_PAGE生命周期中转时留下一个页面元素
NO_ANIMATION_FRAME生命周期动画框架列表为空
COLLINEAR_SEGMENTS内部几何: 段为相线
DEGENERATE_SEGMENT内部几何: 片段有零长度
FLIP_SETUP内部无法准备翻转/下页
INVALID_SPREAD内部转弯时扩展索引无效
RENDER_SETUP内部阴影/ DOM 渲染设置失败
PAGE_FLIP内部通用/未说明

flipNext 编号 : flipPrev 返回时 boolean (单位:千美元)false =没有开始)并发射 turnRejected 当被拒绝时,这不是一条例外的道路.

许可证

MPL - 2.0 导弹 ——文件级复制左. 您的应用程序不是被覆盖的软件 当您只导入并调用 API 时。 发动机的分配 (包括捆绑的浏览器JS)要求源可用性+通知 未修改的 npm 包, 点为 https://github.com/gul-labs/flipbook 页面存档备份,存于互联网档案馆。 。 。 .

版权 (c) 2026 Gul Labs, 上游 Nodlik MIT 通知在 自由主义。 。 。 .

版本与发布记录

@gullabs/flipbook-core 共发布 5 个版本,首次发布于 2026/08/31;过去 12 个月发布了 5 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.2.2latest2026/10/011 个月前
3.2.12026/09/092 个月前
3.2.02026/09/092 个月前
3.1.02026/09/012 个月前
3.0.02026/08/312 个月前

关于 @gullabs/flipbook-core 的常见问题

@gullabs/flipbook-core 是什么?

框架-不可知的页面曲线引擎. 维护了 StPageFlip 的分叉 .

如何安装 @gullabs/flipbook-core?

在项目目录运行 npm install @gullabs/flipbook-core,或使用 pnpm add / yarn add / bun add。

@gullabs/flipbook-core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gullabs/flipbook-core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gullabs/flipbook-core 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gullabs/flipbook-core 可以商用吗?

@gullabs/flipbook-core 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@gullabs/flipbook-core 的下载量有多少?

根据 npm 官方下载统计,@gullabs/flipbook-core 在 2026/10/17 – 2026/11/15 这 30 天内被下载 10,010 次,日均约 334 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gullabs/flipbook-core 还在维护吗?

最新版本 3.2.2 发布于 2026/10/01(1 个月前);至今共发布 5 个版本,其中过去 12 个月发布了 5 个;首次发布于 2026/08/31。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。