Documentation
Mobile
Web
TV

All but React Native are in beta.

Desktop App
docs

Image Overlay

Overlay design mockups directly on your running app to compare against your implementation. Load a mockup, match its scale and position to the screen, and adjust opacity to compare spacing and alignment.

the design on your app, in 84 seconds

The film and the demo show the React Native tool, and the demo uses mock data. Use the Flutter setup and feature descriptions below for supported behavior; the demo does not establish Flutter feature parity.

Compare an example design

1 / 6

This interactive overlay uses a mock storefront and design fixture. Try a tagged target or free placement.

9:41
Loading live demo…
Mock storefront, real component — the same code that renders in your app. Step through the tour, or just start tapping.

Installation

pub
flutter pub add buoy_image_overlay

Using the buoy umbrella? It's already registered. Standalone:

dart
import 'package:buoy_image_overlay/buoy_image_overlay.dart';

registerBuoyImageOverlay();
import 'package:buoy_image_overlay/buoy_image_overlay.dart';

registerBuoyImageOverlay();

Marking Components as Targets

To make a widget discoverable in Component Mode, wrap it in BuoyImageTarget:

dart
BuoyImageTarget(
  label: 'LoginCard',
  child: LoginCard(),
);
BuoyImageTarget(
  label: 'LoginCard',
  child: LoginCard(),
);

The label becomes the name shown in the target list. Add as many targets as you like throughout your app — headers, product cards, tab bars.


Two Modes

Component Mode

Tap Component Match to scan your app and see all tagged targets. Select one, and the overlay pins to that widget — measuring its exact position and size, with a dashed highlight. Optional Auto Track re-measures the target as it moves.

Free Mode

Manually position and resize the overlay anywhere on screen. Drag to move, aspect-lock-resize to scale — useful when you want to compare a full-screen mockup or a section that doesn't map to a single widget.


What You Can Do

  • Opacity control — Blend the mockup over your live UI to spot differences
  • Scale & zoom — Resize the overlay to match your layout
  • X/Y offset — Fine-tune positioning for exact alignment
  • Flip — Mirror the overlay horizontally or vertically
  • Lock — Prevent accidental repositioning while comparing
  • Auto-track — Remeasures the target so the overlay stays locked as it moves

What's Next


FAQ

How do I compare a Flutter screen against a design mockup?

Register buoy_image_overlay, load your exported design into the tool, and overlay it on the running app — adjust opacity, scale, and position until the implementation matches, without leaving the simulator.

Can the overlay follow a specific widget?

Yes — wrap the widget in BuoyImageTarget(label: 'LoginCard') and Component Mode pins the overlay to it, measuring its exact position and size. Auto Track re-measures the target as it moves.