Feedback

https://pub.dev/packages/feedback
Admin
Feedback is a Flutter package that enables users to provide interactive feedback directly in apps by...
Tokens:6,286
Snippets:86
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### HTTP POST Request Example

Source: https://pub.dev/packages/feedback/example

This snippet demonstrates how to construct and send an HTTP POST request with custom headers. It's useful for interacting with APIs that require specific authentication tokens.

```dart
    );
      headers: {
        'PRIVATE-TOKEN': apiToken,
      },
    );
  });
}
```

--------------------------------

### Configure Feedback Theme and Localizations

Source: https://pub.dev/packages/feedback

Set up the BetterFeedback widget with custom theme data and localization delegates. This example shows how to customize the feedback sheet's background, colors, and locale.

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

void main() {
  runApp(
    BetterFeedback(
      child: const MyApp(),
      theme: FeedbackThemeData(
        background: Colors.grey,
        feedbackSheetColor: Colors.grey[50]!,
        drawColors: [
          Colors.red,
          Colors.green,
          Colors.blue,
          Colors.yellow,
        ],
      ),
      localizationsDelegates: [
        GlobalMaterialLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalFeedbackLocalizationsDelegate(),
      ],
      localeOverride: const Locale('en'),
    ),
  );
}
```

--------------------------------

### Add feedback_sentry Dependency

Source: https://pub.dev/packages/feedback_sentry/install

Run this command in your project's root directory to add the feedback_sentry package as a dependency. This command also implicitly runs `flutter pub get`.

```bash
$ flutter pub add feedback_sentry
```

--------------------------------

### Integrate BetterFeedback Widget

Source: https://pub.dev/packages/feedback_gitlab

Wrap your application's root widget with BetterFeedback to enable the feedback functionality. This setup is required before you can trigger the feedback view.

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

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

```

--------------------------------

### Import feedback_sentry in Dart Code

Source: https://pub.dev/packages/feedback_sentry/install

Import the feedback_sentry package into your Dart files to start using its functionalities.

```dart
import 'package:feedback_sentry/feedback_sentry.dart';
```

--------------------------------

### Add feedback_sentry to pubspec.yaml

Source: https://pub.dev/packages/feedback_sentry

Add this dependency to your pubspec.yaml file to include the feedback_sentry package. Remember to run `flutter pub get` afterwards.

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

```

--------------------------------

### Declare feedback_sentry in pubspec.yaml

Source: https://pub.dev/packages/feedback_sentry/install

This is an example of how the feedback_sentry dependency will be added to your `pubspec.yaml` file after running `flutter pub add feedback_sentry`.

```yaml
dependencies:
  feedback_sentry: ^3.2.0
```

--------------------------------

### Upload Feedback to GitLab

Source: https://pub.dev/packages/feedback

Utilize `showAndUploadToGitLab` to automatically create a GitLab issue with the user's feedback. Ensure the API token has the necessary permissions.

```dart
import 'package:feedback_gitlab/feedback_gitlab.dart';

BetterFeedback.of(context).showAndUploadToGitLab(
    projectId: 'project-Id', // Required, use your GitLab project id
    apiToken: 'api-token', // Required, use your GitLab API token
    gitlabUrl: 'gitlab.org', // Optional, defaults to 'gitlab.com'
);

```

--------------------------------

### Provide feedback via platform sharing

Source: https://pub.dev/packages/feedback/example

Uses the share_plus package to open the native platform share sheet with feedback text and a screenshot.

```dart
ElevatedButton(
                child: const Text('Provide feedback via platform sharing'),
                onPressed: () {
                  BetterFeedback.of(context).show(
                    (feedback) async {
                      final screenshotFilePath =
                          await writeImageToStorage(feedback.screenshot);

                      // ignore: deprecated_member_use
                      await SharePlus.instance.share(
                        ShareParams(
                          text: feedback.text,
                          files: [XFile(screenshotFilePath)],
                        ),
                      );
                    },
                  );
                },
              )
```

--------------------------------

### Basic Flutter App Structure

Source: https://pub.dev/packages/feedback_gitlab/example

A standard Flutter application structure demonstrating a basic Material App with a MyHomePage. This serves as the base for integrating the feedback functionality.

```dart
import 'package:feedback_gitlab/feedback_gitlab.dart';
import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text('You have pushed the button this many times:'),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
            ElevatedButton(
              onPressed: () {
                BetterFeedback.of(context).showAndUploadToGitLab(
                  projectId: 'project-id',
                  apiToken: 'api-token',
                );
              },
              child: const Text('Show Feedback view'),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}
```

--------------------------------

### Import feedback_gitlab

Source: https://pub.dev/packages/feedback_gitlab/install

Include the package in your Dart files to access its functionality.

```dart
import 'package:feedback_gitlab/feedback_gitlab.dart';
```

--------------------------------

### Navigate to external URL

Source: https://pub.dev/packages/feedback/example

Opens the provided URL in the default browser using the url_launcher package.

```dart
ElevatedButton(
                child: const Text('Visit library page on pub.dev'),
                onPressed: () {
                  launchUrl(Uri.parse('https://pub.dev/packages/feedback'));
                },
              )
```

--------------------------------

### Show and Upload Feedback to GitLab

Source: https://pub.dev/packages/feedback_gitlab

Call `BetterFeedback.of(context).showAndUploadToGitLab()` to display the feedback panel and upload the collected feedback to a specified GitLab project. You need to provide your GitLab project ID and an API token.

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

```

--------------------------------

### Create GitLab issue from feedback

Source: https://pub.dev/packages/feedback/example

Uploads a screenshot to GitLab and creates an issue using the HTTP package.

```dart
Future<void> createGitlabIssueFromFeedback(BuildContext context) async {
  BetterFeedback.of(context).show((feedback) async {
    const projectId = 'your-gitlab-project-id';
    const apiToken = 'your-gitlab-api-token';

    final screenshotFilePath = await writeImageToStorage(feedback.screenshot);

    // Upload screenshot
    final uploadRequest = http.MultipartRequest(
      'POST',
      Uri.https(
        'gitlab.com',
        '/api/v4/projects/$projectId/uploads',
      ),
    )
      ..files.add(await http.MultipartFile.fromPath(
        'file',
        screenshotFilePath,
      ))
      ..headers.putIfAbsent('PRIVATE-TOKEN', () => apiToken);
    final uploadResponse = await uploadRequest.send();

    final dynamic uploadResponseMap = jsonDecode(
      await uploadResponse.stream.bytesToString(),
    );

    // Create issue
    await http.post(
      Uri.https(
        'gitlab.com',
        '/api/v4/projects/$projectId/issues',
        <String, String>{
          'title': feedback.text.padRight(80),
          'description': '${feedback.text}\n'
```

--------------------------------

### Add feedback_gitlab dependency

Source: https://pub.dev/packages/feedback_gitlab/install

Use the Flutter CLI to add the package to your project.

```bash
$ flutter pub add feedback_gitlab
```

--------------------------------

### Show and Upload Feedback to GitLab

Source: https://pub.dev/packages/feedback_gitlab/example

Call this method on the BetterFeedback instance to display the feedback UI and upload the feedback to GitLab. Requires 'projectId' and 'apiToken' for authentication and issue creation.

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

--------------------------------

### Show Feedback Panel

Source: https://pub.dev/packages/feedback

Call `BetterFeedback.of(context).show()` to display the feedback panel to the user. A callback function is provided to handle the feedback data once submitted.

```dart
BetterFeedback.of(context).show((UserFeedback feedback) {
  // Do something with the feedback
});

```

--------------------------------

### Add feedback dependency via CLI

Source: https://pub.dev/packages/feedback/install

Use this command in your terminal to automatically add the package to your project.

```bash
$ flutter pub add feedback
```

--------------------------------

### Add Feedback Package to pubspec.yaml

Source: https://pub.dev/packages/feedback

Add the feedback package to your project's pubspec.yaml file. Ensure you use the latest version available on pub.dev.

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

```

--------------------------------

### Show and upload feedback to Sentry

Source: https://pub.dev/packages/feedback_sentry

Call this method to display the feedback panel to the user. Optional name and email can be provided. The feedback will be uploaded to Sentry.

```dart
import 'package:feedback_sentry/feedback_sentry.dart';

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

```

--------------------------------

### Add feedback_gitlab to pubspec.yaml

Source: https://pub.dev/packages/feedback_gitlab

Add the feedback_gitlab package as a dependency in your pubspec.yaml file. Ensure you use the latest version available on pub.dev.

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

```

--------------------------------

### Initialize BetterFeedback in Flutter

Source: https://pub.dev/packages/feedback/example

Wraps the application with the BetterFeedback widget to enable feedback functionality, including custom themes and localization.

```dart
import 'dart:convert';
import 'dart:io';
import 'dart:typed_data';

import 'package:example/feedback_functions.dart';
import 'package:feedback/feedback.dart';
import 'package:flutter/foundation.dart' show kIsWeb;
import 'package:flutter/material.dart';
import 'package:flutter_email_sender/flutter_email_sender.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:flutter_markdown/flutter_markdown.dart';
import 'package:http/http.dart' as http;
import 'package:path_provider/path_provider.dart';
import 'package:share_plus/share_plus.dart';
import 'package:url_launcher/url_launcher.dart';

import 'custom_feedback.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

bool _useCustomFeedback = false;

class _MyAppState extends State<MyApp> {
  @override
  Widget build(BuildContext context) {
    return BetterFeedback(
      // If custom feedback is not enabled, supply null and the default text
      // feedback form will be used.
      feedbackBuilder: _useCustomFeedback
          ? (context, onSubmit, scrollController) => CustomFeedbackForm(
                onSubmit: onSubmit,
                scrollController: scrollController,
              )
          : null,
      theme: FeedbackThemeData(
        background: Colors.grey,
        feedbackSheetColor: Colors.grey[50]!,
        drawColors: [
          Colors.red,
          Colors.green,
          Colors.blue,
          Colors.yellow,
        ],
      ),
      darkTheme: FeedbackThemeData.dark(),
      localizationsDelegates: [
        GlobalFeedbackLocalizationsDelegate(),
        GlobalMaterialLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
      ],
      localeOverride: const Locale('en'),
      mode: FeedbackMode.draw,
      pixelRatio: 1,
      child: MaterialApp(
        title: 'Feedback Demo',
        theme: ThemeData(
          primarySwatch: _useCustomFeedback ? Colors.green : Colors.blue,
        ),
        home: MyHomePage(_toggleCustomizedFeedback),
      ),
    );
  }

  void _toggleCustomizedFeedback() =>
      setState(() => _useCustomFeedback = !_useCustomFeedback);
}

class MyHomePage extends StatelessWidget {
  const MyHomePage(this.toggleCustomizedFeedback, {super.key});

  final VoidCallback toggleCustomizedFeedback;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(_useCustomFeedback
            ? '(Custom) Feedback Example'
            : 'Feedback Example'),
      ),
      drawer: Drawer(
        child: Container(color: Colors.blue),
      ),
      body: Padding(
        padding: const EdgeInsets.symmetric(horizontal: 24.0, vertical: 12.0),
        child: SingleChildScrollView(
          child: Column(
            children: <Widget>[
              const MarkdownBody(
                data: '# How does it work?\n'
                    '1. Just press the `Provide feedback` button.\n'
                    '2. The feedback view opens. '
                    'You can choose between draw and navigation mode. '
                    'When in navigate mode, you can freely navigate in the '
                    'app. Try it by opening the navigation drawer or by '
                    'tapping the `Open scaffold` button. To switch to the '
                    'drawing mode just press the `Draw` button on the right '
                    'side. Now you can draw on the screen.\n'
                    '3. To finish your feedback just write a message '
                    'below and send it by pressing the `Submit` button.',
              ),
              const SizedBox(height: 10),
              ElevatedButton(
                child: const Text('Open scaffold'),
                onPressed: () {
                  Navigator.push<void>(
                    context,
                    MaterialPageRoute(
                      builder: (context) {
                        return _SecondaryScaffold();
                      },
                    ),
                  );
                },
              ),
              const Divider(),
              ElevatedButton(
                child: const Text('Provide feedback'),
                onPressed: () {
                  BetterFeedback.of(context).show(
                    (feedback) async {
                      // upload to server, share whatever
                      // for example purposes just show it to the user
                      alertFeedbackFunction(
                        context,
                        feedback,
                      );
                    },
                  );
```

--------------------------------

### Import feedback library

Source: https://pub.dev/packages/feedback/install

Include this import statement at the top of your Dart files to access the package functionality.

```dart
import 'package:feedback/feedback.dart';
```

--------------------------------

### Write screenshot to temporary storage

Source: https://pub.dev/packages/feedback/example

Saves a Uint8List image to the device's temporary directory and returns the file path.

```dart
Future<String> writeImageToStorage(Uint8List feedbackScreenshot) async {
  final Directory output = await getTemporaryDirectory();
  final String screenshotFilePath = '${output.path}/feedback.png';
  final File screenshotFile = File(screenshotFilePath);
  await screenshotFile.writeAsBytes(feedbackScreenshot);
  return screenshotFilePath;
}
```

--------------------------------

### Display a dialog

Source: https://pub.dev/packages/feedback/example

Standard Flutter dialog implementation triggered by a button press.

```dart
ElevatedButton(
                child: const Text('Open Dialog #1'),
                onPressed: () {
                  showDialog<dynamic>(
                    context: context,
                    builder: (_) {
                      return AlertDialog(
                        title: const Text("Dialog #1"),
                        content: Container(),
                      );
                    },
                  );
                },
              )
```

--------------------------------

### Integrate BetterFeedback Widget

Source: https://pub.dev/packages/feedback_gitlab/example

This is the main integration point for the BetterFeedback widget. Wrap your application's root widget with BetterFeedback to enable feedback functionality. Ensure the child widget is properly defined.

```dart
import 'package:feedback_gitlab/feedback_gitlab.dart';
import 'package:flutter/material.dart';

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

--------------------------------

### Add dependency to pubspec.yaml

Source: https://pub.dev/packages/feedback_gitlab/install

Manually add the package to your project's pubspec.yaml file.

```yaml
dependencies:
  feedback_gitlab: ^3.0.0
```

--------------------------------

### Customize Feedback Localizations

Source: https://pub.dev/packages/feedback

Implement custom feedback localizations by extending FeedbackLocalizations and creating a custom delegate. This allows for changing specific text elements within the feedback UI.

```dart
class CustomFeedbackLocalizations implements FeedbackLocalizations {
  // ...
}

class CustomFeedbackLocalizationsDelegate
    extends GlobalFeedbackLocalizationsDelegate {
  static final supportedLocales = <Locale, FeedbackLocalizations>{
    // remember to change the locale identifier
    // as well as that defaultLocale (defaults to en) should ALWAYS be
    // present here or overridden
    const Locale('en'): const CustomFeedbackLocalizations(),
  };
}

void main() {
  runApp(
    BetterFeedback(
      child: const MyApp(),
      localizationsDelegates: [
        GlobalMaterialLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        CustomFeedbackLocalizationsDelegate(),
      ],
    ),
  );
}
```

--------------------------------

### Identify Deprecated Background Property Usage

Source: https://pub.dev/packages/feedback/score

Static analysis report showing the use of the deprecated 'background' property in ColorScheme.

```dart
   ╷
62 │             ? ColorScheme.dark(background: background)
   │                                ^^^^^^^^^^
   ╵
```

```dart
   ╷
63 │             : ColorScheme.light(background: background));
   │                                 ^^^^^^^^^^
   ╵
```

--------------------------------

### Add feedback dependency to pubspec.yaml

Source: https://pub.dev/packages/feedback/install

Manually add this line to the dependencies section of your pubspec.yaml file.

```yaml
dependencies:
  feedback: ^3.2.0
```

--------------------------------

### Define a secondary scaffold

Source: https://pub.dev/packages/feedback/example

A simple stateless widget representing a secondary screen layout.

```dart
class _SecondaryScaffold extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Scaffold 2'),
      ),
      body: const Center(
        child: Text('Hello World'),
      ),
    );
  }
}
```

--------------------------------

### Provide feedback via email

Source: https://pub.dev/packages/feedback/example

Uses the flutter_email_sender package to send feedback text and a screenshot via email. Only available on Android and iOS.

```dart
TextButton(
                  child: const Text('Provide E-Mail feedback'),
                  onPressed: () {
                    BetterFeedback.of(context).show((feedback) async {
                      // draft an email and send to developer
                      final screenshotFilePath =
                          await writeImageToStorage(feedback.screenshot);

                      final Email email = Email(
                        body: feedback.text,
                        subject: 'App Feedback',
                        recipients: ['john.doe@flutter.dev'],
                        attachmentPaths: [screenshotFilePath],
                        isHTML: false,
                      );
                      await FlutterEmailSender.send(email);
                    });
                  },
                )
```

--------------------------------

### Hide Feedback Panel

Source: https://pub.dev/packages/feedback_gitlab

Use `BetterFeedback.of(context).hide()` to programmatically dismiss the feedback panel when needed.

```dart
BetterFeedback.of(context).hide();

```

--------------------------------

### Toggle feedback mode

Source: https://pub.dev/packages/feedback/example

Checks if the feedback overlay is visible before triggering a custom feedback mode.

```dart
MaterialButton(
        color: Theme.of(context).primaryColor,
        shape: const RoundedRectangleBorder(
            borderRadius: BorderRadius.all(Radius.circular(20))),
        child: const Text('toggle feedback mode',
            style: TextStyle(color: Colors.white)),
        onPressed: () {
          // don't toggle the feedback mode if it's currently visible
          if (!BetterFeedback.of(context).isVisible) {
            toggleCustomizedFeedback();
          }
        },
      )
```
Tokens:
Raw