screenshot 0.1.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 97

screenshot #

A simple plugin to capture widgets as Images.

This plugin wraps your widgets inside RenderRepaintBoundary


Getting Started #

This handy plugin can be used to capture any Widget including full screen screenshots & individual widgets like Text().

  1. Create Instance of Screenshot Controller
class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  File _imageFile;

  //Create an instance of ScreenshotController
  ScreenshotController screenshotController = ScreenshotController(); 

  void initState() {
    // TODO: implement initState
  1. Wrap the widget that you want to capture inside Screenshot Widget. Assign the controller to screenshotController that you have created earlier
    controller: screenshotController,
    child: Text("This text will be captured as image"),
  1. Take the screenshot by calling capture method. This will return a File
screenshotController.capture().then((File image) {
    //Capture Done
    setState(() {
        _imageFile = image;
}).catchError((onError) {


  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      body: Container(
        child: new Center(
          child: Column(
            children: <Widget>[
                controller: screenshotController,
                child: Column(
                  children: <Widget>[
                      'You have pushed the button this many times:' +
              _imageFile != null ? Image.file(_imageFile) : Container(),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          _imageFile = null;
              .then((File image) async {
            //print("Capture Done");
            setState(() {
              _imageFile = image;
            final result =
                await; // Save image to gallery,  Needs plugin
            print("File Saved to Gallery");
          }).catchError((onError) {
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ), // This trailing comma makes auto-formatting nicer for build methods.

By defualt, the captured image will be saved to Application Directory. Custom paths can be set using path parameter. Refer path_provider

final directory = (await getApplicationDocumentsDirectory ()).path; //from path_provide package
String fileName =;
path = '$directory/$fileName.png';

    path:path //set path where screenshot will be saved

If you want to save captured image to Gallery, Please use Example app uses the same to save screenshots to gallery.

Note: #

Captured image may look pixelated. You can overcome this issue by setting value for pixelRatio

The pixelRatio describes the scale between the logical pixels and the size of the output image. It is independent of the window.devicePixelRatio for the device, so specifying 1.0 (the default) will give you a 1:1 mapping between logical pixels and the output pixels in the image.

    pixelRatio: 1.5

Known Bugs #

  • Image will not be updated if same filename is given multiple times

[0.1.0] - 11/05/2019

[0.1.0] - 09/05/2019

  • changed path_provider version to ^1.1.0

[0.0.2] - 16/02/2019

  • added support for older versions of path provider

[0.0.1] - 12/02/2019

  • initial release.


example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  screenshot: ^0.1.1

2. Install it

You can install packages from the command line:

with Flutter:

$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:screenshot/screenshot.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Jan 25, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.0
  • pana: 0.13.4
  • Flutter: 1.12.13+hotfix.5

Health suggestions

Fix lib/screenshot.dart. (-1 points)

Analysis of lib/screenshot.dart reported 2 hints:

line 18 col 3: The class 'Future' wasn't exported from 'dart:core' until version 2.1, but this code is required to be able to run on earlier versions.

line 24 col 16: The class 'Future' wasn't exported from 'dart:core' until version 2.1, but this code is required to be able to run on earlier versions.

Format lib/src/main.dart.

Run flutter format to format lib/src/main.dart.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
path_provider ^1.1.0 1.5.1
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
platform 2.2.1
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies