joran-dob/wiredash-sdk

Interactive user feedback tool for Flutter 🎉

Wiredash SDK for Flutter

Wiredash is probably the easiest, and most convenient way to capture in-app user feedback, wishes, ratings and much more. The SDK is completely written in Dart and runs on Android, iOS, Desktop and the Web. For more info, head over to wiredash.io.

🚀 Getting Started

TIP Visit docs.wiredash.io for the in-depth guide and additional info.

1. Create a free account on wiredash.io

Sign in with a valid Google or GitHub account.

2. Add wiredash to your pubspec.yaml.

name: your_flutter_app
dependencies:
  flutter:
    sdk: flutter
  wiredash: ^0.6.0

3. Wrap your root widget with Wiredash

Fill in the projectId and secret from Wiredash console > Project > Settings

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

class MyApp extends StatelessWidget {
  // It's important that Wiredash and your root Material- / Cupertino- / WidgetsApp
  // share the same Navigator key.
  final _navigatorKey = GlobalKey<NavigatorState>();

  @override
  Widget build(BuildContext context) {
    return Wiredash(
      projectId: 'YOUR-PROJECT-ID',
      secret: 'YOUR-SECRET',
      navigatorKey: _navigatorKey,
      child: MaterialApp(
        navigatorKey: _navigatorKey,
        title: 'Flutter Demo',
        home: YourSuperDuperAwesomeApp(),
      ),
    );
  }
}

4. Launch the feedback flow

From anywhere in your app

ElevatedButton(
  // launch wiredash where appropriate in your App 
  onPressed: () => Wiredash.of(context).show(),
  child: Text('Give Feedback'),
),

🎨 Customization

The Wiredash SDK is completely customizable and offers many configuration options!

For all the details, check out the full documentation at docs.wiredash.io/configuration.

📃 License

The Wiredash SDK is released under the Attribution Assurance License. See LICENSE for details.