golden_screenshot 7.2.0

golden_screenshot: ^7.2.0 copied to clipboard

• Added tester.loadAssets(), replacing the previous methods for loading images and fonts. This method loads images and fonts at once, simplifying the API.
• Deprecated tester.loadFonts(), tester.precacheImagesInWidgetTree(), and tester.precacheTopbarImages(). Use tester.loadAssets() instead.
• It is now optional to pass allowedDiffPercent to tester.useFuzzyComparator(). If not provided, it defaults to 0.1 percent.
• Added an example to the README of using a custom frame for more than just system UIs.

• No need to use ScreenshotConditionalTitlebar widget directly anymore. Instead, use the ScreenshotApp.withConditionalTitlebar constructor to do the same thing with less code.
• If you're subclassing ScreenshotFrame, you must now provide the topBar and bottomBar parameters in the constructor (they no longer default to null).

• Polished the README a little and added example screenshots to it.
• Updated the example/demo app to be prettier and have more flexible testing.
• Added an unnamed ScreenshotFrame() constructor for easier subclassing.

• The flathub device was previously a combination of Flathub (Linux) and Play Store (Android) requirements. It has now been split into two separate devices:

  1. The new flathub device:
     • Has rounded corners and a shadow to match real Gnome screenshots.
     • Screenshots are saved in metadata/en-US/images/flathubScreenshots/.
     • I recommend you use a ScreenshotConditionalTitlebar (see below) for a more native look.
  2. The new androidTablet device:
     • Has a top and bottom bar matching Android 16 QPR1 (Material 3 Expressive) tablets.
     • Screenshots are saved in metadata/en-US/images/tenInchScreenshots/.
  3. The renamed androidPhone device:
     • Exactly the same as android from before.
     • Migration can be done automatically with the dart fix tool.

• Added the ScreenshotConditionalTitlebar widget, which adds a Yaru (Ubuntu) themed titlebar to Linux screenshots.
  (As of v7.1.0, prefer using ScreenshotApp.withConditionalTitlebar instead of using this widget directly.)

Migration needed: Update your goldens by running flutter test --update-goldens.

• Updated the top bars to Android 16 QPR1 (Material 3 Expressive) and iOS 26 (Liquid Glass).
• Switched the android device from the Pixel 6 Pro to the Pixel 9 Pro.

• Fixed iOS fonts not being overridden in tester.loadFonts.
• Overridden a bunch more common system fonts: see kOverriddenFonts for the full list.

Migration needed: Delete the metadata/en-US/images/*Screenshots folders and rerun flutter test --update-goldens.

• Apple no longer requires screenshots from olderIphone and olderIpad, so in GoldenScreenshotDevices:
  • olderIphone and olderIpad have been removed.
  • newerIphone and newerIphone have been renamed to iphone and ipad.
• For non-user-facing goldens, you can now use GoldenSmallDevices instead of GoldenScreenshotDevices. It's the same but with a lower resolution, resulting in faster tests.

• You can now run dart fix --apply to automatically rename ScreenshotApp.child to ScreenshotApp.home.

• FEAT: ScreenshotApp now takes any parameter that MaterialApp takes.
• BREAKING TWEAK: ScreenshotApp now takes a home parameter instead of a child parameter. This is to be consistent with MaterialApp.
• BREAKING TWEAK: ScreenshotApp now extends MaterialApp so if you were using find.bySubtype<MaterialApp>() before, you should now use find.byType(MaterialApp).

• If you encounter a font falling back to Ahem, please use await tester.loadFonts(overriddenFonts: ['MYFONT', ...kOverriddenFonts]);
• Removed dependency on the deprecated golden_toolkit package

• Golden screenshots now support all standard font weights, instead of just normal and bold (see #8).

• You can now use testGoldens(...) instead of testWidgets(...) to automatically enable shadows, instead of manually setting and unsetting debugDisableShadows.

• Fixed a compilation error when running flutter test --platform chrome on Flutter 3.29

• Updated the Android topbar to Android 15

• Removed the camera cutout from the iphone top bar

• Fixed the color of the new top bars not being set

• iOS top bar sizes now match exactly with the real devices.
• Switched newerIphone to the iPhone 16 Pro Max.

• Frame colors are now guessed based on the current theme's surface color. This will hopefully be more reliable than the previous SystemChrome based implementation.

• Added ScreenshotFrameColors.dark and ScreenshotFrameColors.light named constants for convenience.

• The top and bottom bar colors are now decided by Flutter. In most cases, this is sufficient, but you can still override the foreground brightness with by passing a ScreenshotFrameColors object to ScreenshotApp.

• Added localization arguments to ScreenshotApp, thanks to @albemala
• Renamed tester.useScreenshotComparator to tester.useFuzzyComparator

• Fixed regression from 2.2.1 where the wrong comparator would be used on io (non-web).

• Fixed compilation issues with flutter test --platform chrome. However, image/font precaching and fuzzy comparison aren't implemented (yet).

• You can now use tester.useScreenshotComparator (Update: renamed to tester.useFuzzyComparator) without having to use tester.expectScreenshot.
• Added a missing widgetType option in precacheImagesInWidgetTree to allow use without ScreenshotApp.

• Screenshots now include dialogs with the default finder

• Fixed an infinite recursion error in device.matchesGoldenFile

• Added the ability to use your own set of devices by creating an enum that stores ScreenshotDevice objects. See the README for more.
• Added the ability to customize where the goldens are stored by setting ScreenshotDevice.screenshotsFolder. See the README for more.
• Added the ability to use multiple locales by passing a locale code to tester.expectScreenshot.
• Because of the above, you'll need to make the following changes (see the example for more):

  # OLD
  for (final device in ScreenshotDevice.values) {
    testWidgets('for ${device.name}', (tester) async {
  # NEW
  for (final goldenDevice in GoldenScreenshotDevices.values) {
    testWidgets('for ${goldenDevice.name}', (tester) async {
      final device = goldenDevice.device;
  

  # OLD
  await tester.expectScreenshot(matchesGoldenFile(
    '${device.goldenFolder}$goldenFileName.png',
  ));
  # NEW
  await tester.expectScreenshot(device, goldenFileName);
  

• Made the Linux screenshots 16:9 so they can also be used for the Play Store.

• Added a fuzzy comparator to allow for 0.1% difference between a widget's expected and actual image. You should replace the usual expectLater with tester.expectScreenshot(matchesGoldenFile(...)) to use this feature.

• You can now run tester.precacheImagesInWidgetTree() to precache all images currently in the widget tree, instead of having to manually specify each image with tester.precacheImages([...])

• Fixed apps that use MediaQuery.size not receiving the simulated screen size

• Added documentation comments to most of the code

• Initial release