flutter_better_scanner library

A drop-in document scanner for Flutter.

Two ways to use it:

1. Built-in UI — one call:

final result = await BetterScanner.openScanner(
  context,
  config: const ScannerConfig(
    captureMode: CaptureMode.multiple,
    shutterMode: ShutterMode.auto,
    autoCrop: true,
    autoEnhance: true,
    exportFormat: ExportFormat.jpg,
  ),
);
final paths = result?.imagePaths ?? [];

2. Your own UI — drive the controller:

final controller = ScannerController(config: myConfig);
await controller.initialize();

// In your build():
ScannerPreview(controller: controller)

// Wire up your own buttons:
controller.cycleFlashMode();
controller.switchCamera();
controller.setGuide(ScanGuide.a4);
controller.setShutterMode(ShutterMode.auto);
controller.setDetectionQuality(DetectionQuality.medium);
await controller.capture();
await controller.pickFromGallery();
final result = await controller.finish();

Live detection state (outline, hint, auto-capture progress) is published through controller.detection, a ValueListenable that updates per frame without rebuilding the camera preview.

3. Your own review screen. The same controller backs the page list, so a custom preview needs no extra plumbing — it is a ListenableBuilder over controller.pages:

// Read
controller.pages;                    // List<ScanPage>
controller.proxyPath(page);          // thumbnail file to show
page.enhancement, page.rotationQuarterTurns, page.cropCorners;

// Edit — each call re-renders and notifies listeners
controller.rotatePage(page);
controller.flipPage(page);
controller.setPageEnhancement(page, ScanEnhancement.magicColor);
controller.setPageAdjustments(page, brightness: 12, contrast: 1.2);
controller.setPageCrop(page, corners);
controller.duplicatePage(page);
controller.deletePage(page);
controller.reorderPages(oldIndex, newIndex);
controller.rename('Invoice 42');

// Borrow a built-in editor from your own screen
await controller.openCropEditor(context, page);
await controller.openEnhanceEditor(context, page);
await controller.openAnnotateEditor(context, page);

// Build your own filter strip
final thumbs = await controller.renderEnhancementThumbnails(page);

final result = await controller.finish();   // exports, returns paths

4. A-la-carte — one editor, on any image. No camera, no session, no package UI around it. Give it a path, get a new path back:

final cropped  = await ScannerEditor.crop(context, imagePath: path);
final enhanced = await ScannerEditor.enhance(context, imagePath: path);
final signed   = await ScannerEditor.annotate(context, imagePath: path);

// Headless — no screen is shown at all:
final turned = await ScannerEditor.rotate(imagePath: path);
final tidy   = await ScannerEditor.autoCrop(imagePath: path);
final bw     = await ScannerEditor.applyEnhancement(
    imagePath: path, enhancement: ScanEnhancement.blackWhite);

// Or hand the package a pile of images and let it run the whole
// review screen over them:
final result = await ScannerEditor.editImages(
    context, imagePaths: myPaths);