ueman/feedback

To use feedback_sentry, you must first follow the setup instructions for sentry_flutter.

After Sentry is configured, add feedback_sentry to your pubspec.yaml dependencies and run flutter pub get.

dependencies:
  feedback_sentry: x.y.z # use the latest version found on pub.dev

To customize the iOS launch screen, replace the existing image files located in the feedback/example/ios/Runner/Assets.xcassets/LaunchImage.imageset/ directory with your own assets.

Alternatively, you can manage these assets using Xcode:

1. Open the iOS workspace using open ios/Runner.xcworkspace.
2. In the Xcode Project Navigator, navigate to Runner/Assets.xcassets.
3. Drag and drop your desired images into the asset catalog.

To enable feedback capabilities, wrap your root application widget with the BetterFeedback widget.

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

void main() {
  runApp(
    BetterFeedback(
      child: const MyApp(),
    ),
  );
}

To use the GitLab feedback integration, add feedback_gitlab to your Flutter project's pubspec.yaml dependencies. After adding the dependency, run flutter pub get in your terminal to install it.

dependencies:
  flutter:
    sdk: flutter
  feedback_gitlab: x.y.z # use the latest version found on pub.dev

The GlobalFeedbackLocalizationsDelegate provides built-in support for many languages including English (en), German (de), French (fr), Arabic (ar), Russian (ru), Spanish (es), Chinese (zh), and many others.

To use the default translations in your Flutter application, add GlobalFeedbackLocalizationsDelegate.delegate to your localizationsDelegates list in MaterialApp.

MaterialApp(
  localizationsDelegates: [
    GlobalFeedbackLocalizationsDelegate.delegate,
    // ... other delegates
  ],
  supportedLocales: [
    const Locale('en'),
    const Locale('de'),
    // ... other supported locales
  ],
  home: MyHomePage(),
);

To use the feedback interface, wrap your application (typically your MaterialApp) with the BetterFeedback widget. This must be placed above any Navigator widgets in your tree to ensure the feedback overlay can be displayed correctly.

By default, BetterFeedback uses FeedbackMode.draw, allowing users to navigate and draw on the screen before submitting feedback. It also defaults to a pixelRatio of 3.0 for screenshot captures.

BetterFeedback(
  child: MaterialApp(
    title: 'App',
    home: MyHomePage(),
  ),
);

Use BetterFeedback.of(context).showAndUploadToGitLab(...) to display the feedback panel and automatically upload the submitted feedback to a GitLab project. You must provide the projectId and a valid apiToken.

BetterFeedback.of(context).showAndUploadToGitLab(
    projectId: 'project-Id',
    apiToken: 'api-token',
);

You can programmatically hide the feedback panel by calling BetterFeedback.of(context).hide().

import 'package:feedback_sentry/feedback_sentry.dart';

BetterFeedback.of(context).hide();

To trigger the feedback panel and automatically upload the user's feedback to Sentry, use BetterFeedback.of(context).showAndUploadToSentry(...).

import 'package:feedback_sentry/feedback_sentry.dart';

BetterFeedback.of(context).showAndUploadToSentry(
    name: 'Foo Bar', // optional
    email: 'foo_bar@example.com', // optional
);

The BetterFeedback widget allows customization of its visual appearance and language:

• themeMode: Controls theme selection. Use ThemeMode.system (default), ThemeMode.light, or ThemeMode.dark.
• theme: The FeedbackThemeData used when themeMode is light or system-is-light.
• darkTheme: The FeedbackThemeData used when themeMode is dark or system-is-dark.
• localizationsDelegates: A list of delegates required if you customize localization. You must include MaterialLocalizations, CupertinoLocalizations, WidgetsLocalizations, and an instance of LocalizationsDelegate<FeedbackLocalizations>.
• localeOverride: Sets a specific Locale for the feedback UI; otherwise, it defaults to the platform locale or English.