research_package 3.2.0

A Flutter framework for obtaining informed consent, showing surveys and collecting results.

example/lib/main.dart

import 'dart:developer';

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:research_package/research_package.dart';
import 'package:carp_serializable/carp_serializable.dart';
import 'package:carp_themes_package/carp_themes_package.dart';

part 'task_page.dart';
part 'research_package_objects/informed_consent.dart';
part 'research_package_objects/linear_survey.dart';
part 'research_package_objects/navigation_direct_step_navigation_rule.dart';
part 'research_package_objects/navigation_step_jump_rule.dart';
part 'research_package_objects/navigation_step_reorganizer_rule.dart';
part 'research_package_objects/other_navigable_survey_examples.dart';

void main() {
  // initialize research package
  // mostly used if you load a RP configurations from a json file
  ResearchPackage.ensureInitialized();

  runApp(const RPDemoApp());
}

class RPDemoApp extends StatelessWidget {
  const RPDemoApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      supportedLocales: const [Locale('en'), Locale('da'), Locale('fr'), Locale('es')],
      localizationsDelegates: [
        // Research Package translations - supports translation of both the
        // RP-specific text as well as app-specific text.
        //  - translations of the RP text is part of the RP Flutter package
        //  - the translations of app text is located in the 'assets/lang/' folder
        //  - the translations of informed consent and surveys are part of the
        //    app text and also included in the the 'assets/lang/' files
        //  - note that only some text is translated -- illustrates that RP
        //    works both with and without translation.
        RPLocalizations.delegate,

        // Research Package translations - supports translation of both;
        //  - the RP-specific text
        //  - app-specific text using the [AssetLocalizationLoader]
        //  - a map-based localization loader [MapLocalizationLoader]
        // RPLocalizationsDelegate(loaders: [
        //   AssetLocalizationLoader(),
        //   MapLocalizationLoader({
        //     'en': {'app_name': 'Research Package Demo'},
        //     'da': {'app_name': 'Research Package Demonstration'},
        //     'fr': {'app_name': 'Demonstration de Research Package'},
        //   }),
        // ]),

        // Built-in localization of basic text for Cupertino widgets
        GlobalCupertinoLocalizations.delegate,
        // Built-in localization of basic text for Material widgets
        GlobalMaterialLocalizations.delegate,
        // Built-in localization for text direction LTR/RTL
        GlobalWidgetsLocalizations.delegate,
      ],
      // Returns a locale which will be used by the app
      localeResolutionCallback: (locale, supportedLocales) {
        // Check if the current device locale is supported
        for (var supportedLocale in supportedLocales) {
          if (supportedLocale.languageCode == locale!.languageCode) {
            return supportedLocale;
          }
        }
        // if the locale of the device is not supported, use the first one
        // from the list (English, in this case).
        return supportedLocales.first;
      },
      theme: carpTheme,
      title: 'Research Package Demo',
      home: const HomePage(),
      debugShowCheckedModeBanner: false,
    );
  }
}

Map<String, RPOrderedTask Function()> get exampleTasks => {
      'informed_consent': () => consentTask,
      'linear_survey': () => linearSurveyTask,
      'branching_survey': () => stepJumpNavigationExample1,
      'branching_survey.step_jump': () => stepJumpNavigationExample2,
      'branching_survey.direct': () => directNavigationExample,
      'branching_survey.reorganizer': () => stepReorganizerNavigationExample,
      'branching_survey.emotional_distress': () => emotionalDistress,
    };

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    RPLocalizations? locale = RPLocalizations.of(context);

    return Scaffold(
      backgroundColor: const Color(0xff003F6E),
      body: SafeArea(
        child: ListView(
          padding: const EdgeInsets.symmetric(vertical: 20, horizontal: 25),
          children: <Widget>[
            Image.asset("assets/images/carp_logo.png", height: 80),
            const SizedBox(height: 20),
            Text(
              locale?.translate("home.welcome") ?? "Welcome",
              textAlign: TextAlign.center,
              style: const TextStyle(fontSize: 16, color: Colors.white),
            ),
            const SizedBox(height: 5),
            Text(
              locale?.translate("home.questions") ?? "Questions?",
              textAlign: TextAlign.center,
              style: const TextStyle(fontSize: 16, color: Colors.white),
            ),
            const SizedBox(height: 5),
            const Text(
              "[e-mail]",
              textAlign: TextAlign.center,
              style: TextStyle(fontSize: 16, color: Colors.white, decoration: TextDecoration.underline),
            ),
            const SizedBox(height: 20),
            for (final entry in exampleTasks.entries)
              Padding(
                padding: const EdgeInsets.only(bottom: 10),
                child: ElevatedButton(
                  style: ElevatedButton.styleFrom(
                    backgroundColor: const Color(0xffC32C39),
                    minimumSize: const Size.fromHeight(60),
                  ),
                  child: Text(
                    locale?.translate(entry.key) ?? entry.key,
                    textAlign: TextAlign.center,
                    style: const TextStyle(color: Colors.white, fontSize: 18),
                  ),
                  onPressed: () => Navigator.of(context).push(
                      MaterialPageRoute<dynamic>(builder: (_) => TaskPage(entry.value()))),
                ),
              ),
          ],
        ),
      ),
    );
  }
}