Flutter SDK

Integrate Traceway into your Flutter app for automatic bug reporting, crash capture, and user feedback.

Flutter SDK

The Traceway Flutter SDK adds in-app issue reporting to any Flutter application. It targets Dart ^3.6.0 and Flutter >=3.27.0, and runs on iOS, Android, Web, macOS, Linux, and Windows from a single package.

Requirements

Requirement	Minimum version
Dart SDK	^3.6.0
Flutter	>=3.27.0

Installation

Add the SDK as a git dependency in your pubspec.yaml:

dependencies:
  traceway:
    git:
      url: https://github.com/tracewaydev/traceway-flutter

flutter pub get

How it works

The diagram below shows the lifecycle of a report from user trigger to platform receipt:

Initialization

import 'package:flutter/material.dart';
import 'package:traceway/traceway.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Traceway.initialize(
    apiKey: 'YOUR_API_KEY',
  );

  runApp(const MyApp());
}

Call initialize() before runApp(). The SDK needs WidgetsFlutterBinding.ensureInitialized() to be called first so it can access platform channels.

Report triggers

By default, users can open the report sheet by shaking their device. This is powered by sensors_plus and works on physical iOS and Android devices.

[PLACEHOLDER: Document all supported trigger types once confirmed from SDK source: shake detection, floating button, programmatic Traceway.show(), crash auto-capture. Include how to enable or disable each in the config.]

Automatic metadata

Every report includes the following fields captured automatically — no code changes required:

Field	Source	Example
Device model	device_info_plus	iPhone 15 Pro
OS version	device_info_plus	iOS 17.4
App version	package_info_plus	1.2.0
Build number	package_info_plus	47
Platform	Flutter runtime	ios
Report ID	uuid	550e8400-e29b...

Configuration options

[PLACEHOLDER: Full config options table once confirmed from SDK source. Known required field: apiKey.]

Platform notes

iOS and Android

Full feature support including shake detection, floating button, and automatic crash reporting.

Web

Shake detection is not available on web (no accelerometer). [PLACEHOLDER: Confirm which trigger mechanisms are available on Flutter Web — floating button, programmatic only?]

Desktop (macOS, Linux, Windows)

[PLACEHOLDER: Confirm which features work on desktop targets — shake is not applicable, document available triggers.]

Troubleshooting

If flutter pub get fails with a git error, ensure you have access to the repository and that git is installed and authenticated on your machine.

[PLACEHOLDER: Additional troubleshooting entries once common issues are known — initialization errors, API key rejected, reports not appearing in dashboard, shake not triggering on simulator.]

Changelog

See the GitHub repository for version history and release notes.

← Previous

API Reference

Introduction