Generate documentation screenshots of your widgets.
Add the following to your pubspec.yaml
file:
dev_dependencies:
showcase: <1.0.0
then run:
flutter packages get
Then you can either annotate the widgets you want to have showcased or manually create a test file with multiple widgets:
Add another dependency to your pubspec.yaml
file:
dev_dependencies:
build_runner: ^0.10.0
Just annotate the widgets you want with @Showcased
:
import 'package:showcase/showcase.dart';
@Showcased()
class MyWidget extends StatelessWidget {
// ...
}
The builder will generate a _test.showcased.dart
test file for each annotated class file. Just run:
flutter packages pub run build_runner build
Create a test file with the following:
import 'package:flutter_test/flutter_test.dart';
import 'package:showcase/showcase.dart';
void main() {
group('Showcase!', () {
showcaseWidgets([]);
});
}
Replace the empty list with a collection of widgets. showcaseWidgets
also have some options you can tweak.
Then it's just a matter of running flutter test
and have your screenshots generated on ./showcase/
(or another output directory you had configured).