@ gullabs/ 反应- flipbook
反应18/19 装订 @gullabs/flipbook-core。 。 。 .
维持了反应分叉-pageflip. 许可证 : 麻省理工学院 (引擎依赖是MPL-2.0).
完整单重文件 :
- https://github.com/gul-labs/flipbook#readme 页面存档备份,存于互联网档案馆
- 从
[email protected]数字 : https://github.com/gul-labs/flipbook/blob/main/MIGARINE.md 互联网档案馆的存檔,存档日期2014-12-21 - 已锁定 API 表面 : https://github.com/gul-labs/flipbook/blob/main/docs/API-CONTRACT.md 互联网档案馆的存檔,存档日期2013-12-22
- 活页面 (描述/ 突出显示) : https://github.com/gul-labs/flipbook/blob/main/docs/LIVE-PAGE-FACES.md 互联网档案馆的存檔,存档日期2013-12-22
npm i @gullabs/react-flipbook
# pulls @gullabs/flipbook-core; react is a peer (>=18)
快速启动
import { useState } from 'react';
import HTMLFlipBook, { type BookSnapshot } from '@gullabs/react-flipbook';
export function Book() {
// Seed from onLoaded. onPageChange fires only for real turns, never on mount.
const [book, setBook] = useState<{ page: number; pageCount: number } | null>(null);
const sync = (s: BookSnapshot) => setBook({ page: s.page, pageCount: s.pageCount });
return (
<>
<p>{book ? `Page ${book.page + 1} of ${book.pageCount}` : 'Loading…'}</p>
<HTMLFlipBook width={300} height={500} onLoaded={sync} onPageChange={sync}>
{/* Host element required. Style content on an INNER wrapper — the
engine owns layout + paper on the leaf root. */}
<div>
<div style={{ height: '100%', padding: 16 }}>Page 1</div>
</div>
<div>
<div style={{ height: '100%', padding: 16 }}>Page 2</div>
</div>
</HTMLFlipBook>
</>
);
}
首小时规则
onLoaded初始计数器 —— 说onPageChange/ 核心flip别 在挂载上起火(仅在页索引实际变化时起火).- 内置包装符样式,而不是叶根. 引擎写位置, 大小、剪接和纸张在根上.
- 已控制
page需求onPageChange- 否则引擎会转动 你的道具把它折回(一本被锁入的书). - 不驱动
initialPage从活的 URL 状态 - 这是一个重挂键. 冻结在山上或使用控制的深层链接page。 。 。 . - 保持页面儿童身份稳定
onTurnProgress。 。 。 . 纪念 页面元素。 一个在每次进步中重建它们的父母 都会流泪 书到中途。 把洗手手手拇指放进兄弟会,别放在页面上 孩子们.
常见道具和活动
| 宣传/事件 | 作用 |
|---|---|
width 编号 : height | 需要的页面大小 |
page + 键 onPageChange | 控制页面( 可选) pageTransition数字 : 'animate' | 'instant'(中文(简体) ) |
onLoaded 编号 : onReady | 初始 / 一次/ 一次引擎快照( E)page, (中文(简体) ), pageCount, (中文(简体) ), visiblePages, (...) (中文(简体) ) |
onTurnProgress | 折叠进度 0…1 在动画或拖动时。 静静地在瞬间/减速转弯和悬浮地皮上 解决 onPageChange 编号 : onChangeState。 。 。 . |
lazyRadius | 仅反应窗口 。 核心 PageFlip 忽略它; 香草主机必须窗口 DOM 本身 . |
onTurnRejected | 转动未启动( T)reason, (中文(简体) ), direction, (中文(简体) ), targetPage, (中文(简体) ), landedOn(中文(简体) ) |
controls | 'auto' | 'visible' | 'none' |
hardCovers | 单叶覆盖,密度高 |
pageBackground | 纸张颜色( 任何 CSS 颜色; 不透明为结构) |
injectStyles | 默认 true; 设置 false 严格CSP和进口核心 style.css |
| 页面媒体 | 纵向卷发会结冰 <video> 作为画布和条纹 <audio>。 。 。 . video[controls], (中文(简体) ), audio[controls], (中文(简体) ), iframe, (中文(简体) ), embed,以及 object 不要开始折叠。 播放并暂停停留主机的工作——参见核心README. |
处理方法ref → FlipBookHandle:
| 方法 | 作用 |
|---|---|
flipNext 编号 : flipPrev | 相对转动( A)boolean(中文(简体) ) |
flipToPage(n) | 动画到页面( A)boolean(中文(简体) ) |
turnToPage(n) | 即时跳跃( I)boolean(中文(简体) ) |
cancelTurn() | 放弃在飞行中转弯而不作出承诺. read 在肖像复制被移除后,在完成的转弯和取消时起火. |
destroy() | 把引擎拆下来 财务报告和审定财务报表 退出反弹壳 |
pageFlip() | 逃生舱-核心 PageFlip | null |
查询诸如 getPageCount 编号 : getVisiblePages 住在这里 引擎
(单位:千美元)pageFlip()?.getPageCount())或打开 usePageFlip() 状态——不在握把上.
偏爱 destroy() 把手放在那边 pageFlip()?.destroy(): 后一眼泪
引擎关闭,但在下一次渲染之前不退出反弹壳.
许可证
麻省理工为这个包裹。 发动机@gullabs/flipbook-core)是MPL-2.0——见
https://github.com/gul-labs/flipbook/blob/main/packages/core/LICENSE 互联网档案馆的存檔,存档日期2013-12-02。 。 。 .
版权 (c) 2026 Gul Labs.