page_flip_view 0.3.0

Turn pages like a real book. A diagonal corner curl that follows the finger, for any widgets and for PDF files (rendered with pdfrx).

page_flip_view

Turn pages like a real book or magazine. The page corner lifts diagonally, follows your finger, and falls back or turns over when you let go. Use it for PDF books, magazines, catalogues, comics, or any list of widgets.

Features

• Diagonal corner curl that tracks the finger (top or bottom corner, whichever you grab)
• Release past the middle or fling to turn; otherwise the page falls back
• Tap the page edges to turn; tap the middle for your own action (show a toolbar, for example)
• The back of the turning page shows the page faintly through the paper, with soft fold shadows
• Pinch or double tap to zoom; PDF pages are re-rendered sharp at the zoom level
• PDF from a URL, a file, an asset or bytes, with download progress, passwords and night mode
• No spinner while turning PDF pages: a small preview appears at once and sharpens a moment later
• PageFlipController for previous / next / jump from buttons or sliders

Getting started

1. Add the package

dependencies:
  page_flip_view:
    git:
      url: https://github.com/aqsaldpa/page_flip_view.git
      ref: v0.3.0

2. Platform setup (only needed for PDFs)

• iOS: iOS 15 or newer. In ios/Podfile set platform :ios, '15.0', then run pod install in ios/.
• Android: nothing to do for local PDFs. For PdfFlipBook.network, make sure android/app/src/main/AndroidManifest.xml has <uses-permission android:name="android.permission.INTERNET" /> (Flutter only adds it to debug builds).
• macOS: macOS 12 or newer; for network PDFs enable Outgoing Connections (Client) in the app sandbox.

3. Show a book

import 'package:page_flip_view/pdf.dart';

class BookScreen extends StatelessWidget {
  const BookScreen({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      backgroundColor: Colors.grey.shade800,
      body: SafeArea(
        child: PdfFlipBook.network(
          Uri.parse('https://example.com/book.pdf'),
        ),
      ),
    );
  }
}

That is all. Opening, downloading, rendering, caching and cleanup are handled for you.

Open a PDF from anywhere

PdfFlipBook.network(Uri.parse(url), headers: {'Authorization': 'Bearer $token'})
PdfFlipBook.file('/path/to/book.pdf')       // a file on the device
PdfFlipBook.asset('assets/book.pdf')        // bundled with the app (list it under flutter/assets)
PdfFlipBook.data(bytes)                     // after downloading or decrypting yourself
PdfFlipBook.document(pdfDocument)           // a pdfrx PdfDocument you opened yourself

Every constructor takes password for encrypted files.

Any widgets as pages

import 'package:page_flip_view/page_flip_view.dart';

PageFlipView(
  itemCount: photos.length,
  itemBuilder: (context, index) => Image.network(photos[index], fit: BoxFit.cover),
)

Only the current page and the pages taking part in a turn are built.

Control it from code

final controller = PageFlipController();

PdfFlipBook.file(
  path,
  controller: controller,
  onLoaded: (pageCount) => setState(() => total = pageCount),
  onPageChanged: (page) => saveLastRead(page),
  onCenterTap: toggleToolbar,
);

controller.next();      // animated turn forward
controller.previous();  // animated turn back
controller.jumpTo(12);  // instant
controller.page;        // current page, zero based (the controller is a ChangeNotifier)

Dispose the controller in your State.dispose.

Night mode

PdfFlipBook.file(
  path,
  colorFilter: PdfFlipBook.nightMode,
  paperColor: const Color(0xFF1E1E1E),
)

Loading, placeholders and errors

PdfFlipBook.network(
  uri,
  loadingBuilder: (context, progress) => LinearProgressIndicator(value: progress),
  errorBuilder: (context, error, retry) => TextButton(onPressed: retry, child: const Text('Retry')),
  placeholderBuilder: (context, page) => const ColoredBox(color: Colors.white),
  pageErrorBuilder: (context, page, retry) => IconButton(onPressed: retry, icon: const Icon(Icons.refresh)),
)

progress goes from 0 to 1 while a network PDF downloads, and is null when the size is unknown.

All options

PageFlipView and PdfFlipBook:

Parameter	Default	What it does
controller		Turn pages from code
onPageChanged		Called with the page index after a turn or jump
onCenterTap		Tap in the middle of the page
paperColor	white	Paper colour behind pages and on the back
enableZoom	true	Pinch and double tap zoom; one finger pans while zoomed
maxScale	4	Largest zoom factor

PageFlipView only:

Parameter	Default	What it does
itemCount, itemBuilder	required	The pages
initialPage	0	First page when no controller is given
flipDuration	300 ms	Length of a full turn
followFactor	0.22	How fast the curl catches the finger; lower feels heavier
backsideOpacity	0.2	How much of the page shows through its back
edgeTapFraction	0.2	Width of the tap-to-turn zones
enableDrag, enableTapToFlip	true	Turn gestures on or off
doubleTapScale	2.5	Zoom factor of a double tap
onZoomChanged		Called when a zoom settles, e.g. to load a sharper image

PdfFlipBook only: onLoaded, loadingBuilder, placeholderBuilder, pageErrorBuilder, errorBuilder, password, colorFilter, and headers / timeout for .network.

Taps on the page edges turn pages at once. A tap in the middle waits a moment (the double tap window) before calling onCenterTap, because a second tap there zooms.

Which PDF engine

PDF pages are rendered with pdfrx (MIT), which bundles Google's PDFium, the engine inside Chrome.

• Renders in a background isolate, so turning stays smooth.
• Renders can be cancelled, so fast page turning does not queue up work.
• Handles encrypted PDFs, forms and annotations, on Android, iOS, macOS, Windows, Linux and web.
• Adds PDFium to your app, a few MB per platform. On iOS and macOS you can swap in Apple's own renderer with pdfrx_coregraphics to save that space.

Only the pages near the current one are kept at full resolution (6 by default); small previews are kept for up to 60 pages.

How the curl works

The fold line is the perpendicular bisector between the page corner and the finger. The part of the page beyond the line is cut away, and its mirror image across the line becomes the curled flap. The finger is kept within reach of the spine so the paper never tears off. While dragging, the curl eases towards the finger by followFactor each frame; after release it finishes with an ease-out sine over the remaining part of flipDuration.

Example

example/ has three tabs: a bundled PDF with night mode, a PDF downloaded from a URL, and plain widgets.

cd example
flutter run

Not yet

• Right-to-left books (for example Arabic or Japanese)
• Two-page spreads on tablets

License

MIT. See LICENSE.