sunlight_flutter 0.1.0

Automatic event documentation with screenshots for Flutter applications.

example/example.md

🧑‍💻 How to Use

1. In your app initialization, set up sunlight with the desired options:

SunlightAnalyticsFlutter.setup(
  boardClient: miroBoardClient(
    boardId: "your_board_id",
    token: "your_api_token",
  ),
);

2. To allow capturing screenshots you need to wrap the entire section you want to be tracked with a custom Sunlight widget.

runApp(
  MaterialApp(
    home: Sunlight(
      child: Home(),
    ),
  ),
);

example: main.dev.dart

3. In your current centralized analytics logging, add sunlight logs:

class CurrentAnalyticsLogger {
  Future<void> logEvent(String name) {
    // current analytics logging.
    return SunlightAnalytics.log(name: name);
  }
}