screenshot

Flutter Screenshot Package (Runtime). Capture any Widget as an image.


License
Other

Documentation

screenshot

A simple plugin to capture widgets as Images.

This plugin wraps your widgets inside RenderRepaintBoundary

Source

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(); 

  @override
  void initState() {
    // TODO: implement initState
    super.initState();
  }
  ...
}
  1. Wrap the widget that you want to capture inside Screenshot Widget. Assign the controller to screenshotController that you have created earlier
Screenshot(
    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) {
    print(onError);
});

Example:

@override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Container(
        child: new Center(
          child: new Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              Screenshot( //Screenshot Widget
                controller: screenshotController, //asign Controller
                //wrap the widgets that you want to capture as image
                child: <Widget>[ 
                      Text(
                        'You have pushed the button this many times:' +
                            _counter.toString(),
                      ),
                      FlutterLogo(),
                    ],
                ),
              _imageFile != null ? Image.file(_imageFile) : Container(),
            ],
          ),
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          _incrementCounter();
          _imageFile = null;
          screenshotController.capture().then((File image) {
            setState(() {
              _imageFile = image;
            });
          }).catchError((onError){
            print(onError);
          });
          
        },
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }

screenshot

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 = DateTime.now().toIso8601String();
path = '$directory/$fileName.png';

screenshotController.capture(
    path:path //set path where screenshot will be saved
);

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.

screenshotController.capture(
    pixelRatio: 1.5
)

Known Bugs

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