Skip to content
Screenshots: A command line utility and package for capturing screenshots for Flutter
Branch: master
Clone or download
Pull request Compare This branch is 39 commits behind mmcc007:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
bin
example
lib
test
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
analysis_options.yaml
pubspec.yaml

README.md

pub package Build Status

alt text

Screenshot with overlaid status bar and appended navigation bar placed in a device frame.

For an example of images generated with Screenshots on a live app in both stores see:
GitErDone GitErDone

See a demo of Screenshots in action: Screenshots demo

For introduction to Screenshots see article.

For information on automating Screenshots with a CI/CD tool see fledge.

Screenshots

Screenshots is a standalone command line utility and package for capturing Screenshots for Flutter. It will start the required android emulators and iOS simulators, run your screen capture tests on each emulator/simulator for each locale your app supports, process the images, and drop them off for Fastlane for delivery to both stores.

It is inspired by three tools from Fastlane:

  1. Snapshots
    This is used to capture screenshots on iOS using iOS UI Tests.
  2. Screengrab
    This captures screenshots on android using android espresso tests.
  3. FrameIt
    This is used to place captured iOS screenshots in a device frame.

Since all three of these Fastlane tools do not work with Flutter, Screenshots combines key features of all three Fastlane tools into one tool. Plus, it is much easier to use!

Screenshots features:

  1. Captures screenshots from any iOS simulator or android emulator and processes images.
  2. Frames screenshots in an iOS or android device frame.
  3. The same Flutter integration test can be used across all simulators/emulators.
    No need to use iOS UI Tests or Espresso.
  4. Integrates with Fastlane's deliver and supply for upload to respective stores.

Usage

$ screenshots

Or, if using a config file other than the default 'screenshots.yaml':

$ screenshots -c <path to config file>

Modifying tests for Screenshots

Capturing screenshots using this package is straightforward.

A special function is provided in the Screenshots package that is called by the test each time you want to capture a screenshot. Screenshots will then process the images appropriately during a Screenshots run.

To capture screenshots in your tests:

  1. Include the Screenshots package in your pubspec.yaml's dev_dependencies section
      screenshots: ^<current version>
  2. In your tests
    1. Import the dependencies
      import 'package:screenshots/config.dart';
      import 'package:screenshots/capture_screen.dart';
    2. Create the config map at start of test
           final Map config = Config().config;
    3. Throughout the test make calls to capture screenshots
          await screenshot(driver, config, 'myscreenshot1');

Note: make sure your screenshot names are unique across all your tests.

Note: to turn off the debug banner on your screens, in your integration test's main(), call:

  WidgetsApp.debugAllowBannerOverride = false; // remove debug banner for screenshots

Screenshots on Travis

To view Screenshots running with the example app on travis see:
https://travis-ci.com/mmcc007/screenshots

To download the images generated by Screenshots during run on travis see:
https://github.com/mmcc007/screenshots/releases/

Configuration

To run Screenshots you need to setup a configuration file, screenshots.yaml:

# Screen capture tests
tests:
  - test_driver/test1.dart
  - test_driver/test2.dart

# Interim location of screenshots from tests
staging: /tmp/screenshots

# A list of locales supported by the app
locales:
  - de-DE
  - en-US

# A list of devices to emulate
devices:
  ios:
    - iPhone X
#    - iPhone 7 Plus
    - iPad Pro (12.9-inch) (2nd generation)
#   "iPhone 6",
#   "iPhone 6 Plus",
#   "iPhone 5",
#   "iPhone 4s",
#   "iPad Retina",
#   "iPad Pro"
  android:
    - Nexus 6P
#    - Nexus 5X

# Frame screenshots
frame: true

Note: emulators and simulators corresponding to the devices in your config file must be installed on your test machine.

Changing devices

If you want to know what your screens look like on different devices just change the list of devices in screenshots.yaml.

Make sure the devices you select have supported screens and corresponding emulators/simulators.

Within each class of ios and android device, multiple devices share the same screen size. Devices are therefore organized by supported screens in a file called screens.yaml.

For each selected device:

  1. Confirm device in present in screens.yaml.
  2. Add device to the list of devices in screenshots.yaml.
  3. Install an emulator or simulator for device.

If changing devices seems tricky at first. Don't worry. Screenshots will validate the config file before running.

If you want to use a device that is not included in screens.yaml , please create an issue. Include the name of the device and preferably the size of the screen in pixels (for example, Nexus 5X:1080x1920).

Installation

To install Screenshots on the command line:

$ pub global activate screenshots

To upgrade, simply re-issue the command

$ pub global activate screenshots

Note: the Screenshots version should be the same for both the command line and package:

  1. If upgrading the command line version of Screenshots, it is helpful to also upgrade the version of Screenshots in your pubspec.yaml.
  2. If upgrading Screenshots in your pubspec.yaml, you should also upgrade the command line version.

Dependencies

Screenshots depends on ImageMagick.

Since screenshots are required by both Apple and Google stores, testing should be done on a Mac (unless you are only testing for android).

brew update && brew install imagemagick

Integration with Fastlane

Since Screenshots is intended to be used with Fastlane, after Screenshots completes, the images can be found in:

android/fastlane/metadata/android
ios/fastlane/screenshots

Images are in a format suitable for upload via deliver and supply.

If you intend to use fastlane it is better to install fastlane files, in both ios and android directories, prior to running Screenshots. (See fledge for more info.)

Issues and Pull Requests

Issues and pull requests are welcome.

Your feedback is welcome and is used to guide where development effort is focused. So feel free to create as many issues and pull requests as you see fit. You should expect a timely and considered response.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.