HTML Flip Book - v0.0.0-alpha.36
    Preparing search index...

    HTML Flip Book - v0.0.0-alpha.36

    HTML Flip Book

    CI CD Codecov Codacy Grade Documentation

    npm vanilla npm react

    A TypeScript library for creating realistic page-flip animations in the browser.

    ๐Ÿ“– Live Demo ยท ๐Ÿ“š API Docs

    # Vanilla JavaScript
    npm install html-flip-book-vanilla

    # React
    npm install html-flip-book-react
    • RTL & LTR Support โ€” Horizontal flip direction for both reading directions
    • Touch & Mouse Input โ€” Drag pages with touch gestures or mouse
    • Velocity-based Flipping โ€” Fast swipes complete the flip automatically
    • Progress-based Flipping โ€” Partial drags complete based on progress threshold
    • Concurrent Flip Animations โ€” Multiple pages can flip simultaneously
    • Hover Effects โ€” Subtle inner-shadow preview on page edges
    • Leaves Buffer โ€” Performance optimization for large books (only render nearby pages)
    • Toolbar Components โ€” Pre-built navigation UI:
      • Toolbar โ€” Container component
      • PrevButton / NextButton โ€” Navigate pages
      • FirstPageButton / LastPageButton โ€” Jump to ends
      • PageIndicator โ€” Current page display
      • FullscreenButton โ€” Toggle fullscreen mode
    • Imperative API โ€” flipNext(), flipPrev(), flipToPage(), jumpToPage()
    • Ref Handle โ€” Access current page index, total pages, navigation state
    • Live Demo โ€” English (LTR) and Hebrew (RTL) books
    • [ ] Curl animation / animated page edges
    • [ ] Vertical flip direction
    • [ ] Vue component
    • [ ] Angular component