Flutter Survey Logo

Pub License: MIT style: flutter lints License: MIT

Flutter Survey Logo Flutter Survey

Inspired by Google Forms

A simple yet powerful package that handles the creation of a dynamic questionnaire/research survey with conditional questions. Have you ever wanted to implement a form/questionnaire/survey like the ones you see on Google forms? Have you ever wanted to implement conditional questions that show or hide the questions that follow, based on the user’s input? This package helps you build data collection forms hassle-free.

Screenrecorder-2021-05-11-20-23-21-153

📋 Features

✔ī¸ Eliminates boilerplate code for surveys. ✔ī¸ Implement Conditional/Single Choice/Multiple Choice questions. ✔ī¸ Intuitively construct your own questions with infinite nesting. ✔ī¸ Customize it by creating your own form widgets from scratch using the builder method. ✔ī¸ Add your own properties for your custom widgets. ✔ī¸ Supports validation using the Form widget ✔ī¸ Implicitly supports Dark theme.

🔮 Next Update

✔ī¸ Supports Internationalization. ✔ī¸ Supports custom regex validation ✔ī¸ Supports various formats of input (Date Picker, File Upload, Slider etc) ✔ī¸ Track progress

⚙ī¸ Installation

This project requires the latest version of Dart. You can download the latest and greatest here.

1. Depend on it

Add this to your package’s pubspec.yaml file:

dependencies:
    flutter_survey: '^0.1.0'

2. Install it

You can install packages from the command line:

$ pub get
..

Alternatively, your editor might support pub. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:flutter_survey/survey.dart';

📖 Usage

First, you must initialize the question structure where you specify the type of questions and their possible answers, if any. You can also nest questions to form conditional questions. You can even mark them as mandatory. This can be either in json format fetched from the server or can be constructed using the [Question] model provided as part of this package. The structure is intuitive and determines the flow of the form.

Types of questions

The Questions are classified based on the kind of input they take.

Text Input Question

As the name suggests here the answer is not limited to any specific choice. The answer to this question can be typed in by the user, single line or multiline. Setting the answerChoice variable to null or simply leaving it altogether gives you this.

Question(
 question: "What is your name?",
)

Single Choice Question

Here, Radio Buttons are used as input. You define the possible answer choices as a Map, with the keys being the answer choices. Note that the value of the corresponding keys happen to be null. This is because they don’t have an associated list of questions that follow it.

 Question(
   question: 'Do you like drinking coffee?',
   answerChoices: {
     "Yes": null,
     "No": null,
   },
 ),

Multiple Choice Question

Here, Checkboxes are used as input. Just like the Single Choice Questions, You define the possible answer choices as a Map with the keys being the answer choices. Note that even here the value of the corresponding keys happen to be null for the same reason as Single Choice Questions. The difference here is that you set isSingleChoice to false.

Question(
  isSingleChoice: false,
  question: 'What are the brands that you have tried?',
  answerChoices: {
    "Nestle": null,
    "Starbucks": null,
    "Coffee Day": null,
  },
),

Conditional/Nested Questions

This is where you define questions that follow based on the answer of the question prior to it. The values of the keys defined in the answerChoices field determines the flow. For example here, if the user were to choose “Yes” to “Do you like drinking coffee”, the user would be confronted with another question “What are the brands you’ve tried?” followed by more nesting.

 Question(
   isMandatory: true,
   question: 'Do you like drinking coffee?',
   answerChoices: {
     "Yes": [
       Question(
           singleChoice: false,
           question: "What are the brands that you've tried?",
           answerChoices: {
             "Nestle": null,
             "Starbucks": null,
             "Coffee Day": [
               Question(
                 question: "Did you enjoy visiting Coffee Day?",
                 isMandatory: true,
                 answerChoices: {
                   "Yes": [
                     Question(
                       question: "Please tell us why you like it",
                     )
                   ],
                   "No": [
                     Question(
                       question: "Please tell us what went wrong",
                     )
                   ],
                 },
               )
             ],
           })
     ],
     "No": [
       Question(
         question: "Do you like drinking Tea then?",
         answerChoices: {
           "Yes": [
             Question(
                 question: "What are the brands that you've tried?",
                 answerChoices: {
                   "Nestle": null,
                   "ChaiBucks": null,
                   "Indian Premium Tea": [
                     Question(
                       question: "Did you enjoy visiting IPT?",
                       answerChoices: {
                         "Yes": [
                           Question(
                             question: "Please tell us why you like it",
                           )
                         ],
                         "No": [
                           Question(
                             question: "Please tell us what went wrong",
                           )
                         ],
                       },
                     )
                   ],
                 })
           ],
           "No": null,
         },
       )
     ],
   },
 ),

A full question structure represented as a List:

 List<Question> _initialData = [
  Question(
    isMandatory: true,
    question: 'Do you like drinking coffee?',
    answerChoices: {
      "Yes": [
        Question(
            singleChoice: false,
            question: "What are the brands that you've tried?",
            answerChoices: {
              "Nestle": null,
              "Starbucks": null,
              "Coffee Day": [
                Question(
                  question: "Did you enjoy visiting Coffee Day?",
                  isMandatory: true,
                  answerChoices: {
                    "Yes": [
                      Question(
                        question: "Please tell us why you like it",
                      )
                    ],
                    "No": [
                      Question(
                        question: "Please tell us what went wrong",
                      )
                    ],
                  },
                )
              ],
            })
      ],
      "No": [
        Question(
          question: "Do you like drinking Tea then?",
          answerChoices: {
            "Yes": [
              Question(
                  question: "What are the brands that you've tried?",
                  answerChoices: {
                    "Nestle": null,
                    "ChaiBucks": null,
                    "Indian Premium Tea": [
                      Question(
                        question: "Did you enjoy visiting IPT?",
                        answerChoices: {
                          "Yes": [
                            Question(
                              question: "Please tell us why you like it",
                            )
                          ],
                          "No": [
                            Question(
                              question: "Please tell us what went wrong",
                            )
                          ],
                        },
                      )
                    ],
                  })
            ],
            "No": null,
          },
        )
      ],
    },
  ),
  Question(
      question: "What age group do you fall in?",
      isMandatory: true,
      answerChoices: const {
        "18-20": null,
        "20-30": null,
        "Greater than 30": null,
      })
];

Pass the list of questions to the ConditionalQuestions Widget.

This is the main widget that handles the form.

         Survey(
          initialData: _surveyData,
        )

Full code:

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(
        brightness: Brightness.light,
      ),
      darkTheme: ThemeData(
        brightness: Brightness.dark,
      ),
      themeMode: ThemeMode.system,
      title: 'Flutter Demo',
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

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

  final String? title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final _formKey = GlobalKey<FormState>();
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title!),
      ),
      body: Form(
        key: _formKey,
        child: Survey(
          onNext: (questionResults) {
            print(questionResults);
            //store the result
          },
          initialData: [
            Question(
              isMandatory: true,
              question: 'Do you like drinking coffee?',
              answerChoices: {
                "Yes": [
                  Question(
                      singleChoice: false,
                      question: "What are the brands that you've tried?",
                      answerChoices: {
                        "Nestle": null,
                        "Starbucks": null,
                        "Coffee Day": [
                          Question(
                            question: "Did you enjoy visiting Coffee Day?",
                            isMandatory: true,
                            answerChoices: {
                              "Yes": [
                                Question(
                                  question: "Please tell us why you like it",
                                )
                              ],
                              "No": [
                                Question(
                                  question: "Please tell us what went wrong",
                                )
                              ],
                            },
                          )
                        ],
                      })
                ],
                "No": [
                  Question(
                    question: "Do you like drinking Tea then?",
                    answerChoices: {
                      "Yes": [
                        Question(
                            question: "What are the brands that you've tried?",
                            answerChoices: {
                              "Nestle": null,
                              "ChaiBucks": null,
                              "Indian Premium Tea": [
                                Question(
                                  question: "Did you enjoy visiting IPT?",
                                  answerChoices: {
                                    "Yes": [
                                      Question(
                                        question:
                                        "Please tell us why you like it",
                                      )
                                    ],
                                    "No": [
                                      Question(
                                        question:
                                        "Please tell us what went wrong",
                                      )
                                    ],
                                  },
                                )
                              ],
                            })
                      ],
                      "No": null,
                    },
                  )
                ],
              },
            ),
            Question(
                question: "What age group do you fall in?",
                isMandatory: true,
                answerChoices: const {
                  "18-20": null,
                  "20-30": null,
                  "Greater than 30": null,
                })
          ],
        ),
      ),
      bottomNavigationBar: TextButton(
        child: Text("Validate"),
        onPressed: () {
          if (_formKey.currentState!.validate()) {
            //do something
          }
        },
      ),
    );
  }
}

🤝 Contributing

Help make this package more useful and serve the needs of the community by reporting bugs, submitting feedback and/or opening a PR.

ℹī¸ About me

Visit my LinkedIn at https://www.linkedin.com/in/michel98

GitHub

View Github