flutter_start

Flutter_start is a package that allows you to jumpstart your application with a splashScreen, introduction and a home.

Setup

To use this package, add flutter_start as a dependency in your pubspec.yaml file:

  flutter_start:
    git:
      url: https://github.com/Iconica-Development/flutter_start
      ref: <Version>

To use the module within your Flutter-application with predefined Go_router routes you should add the following:

Add go_router as dependency to your project. Add the following configuration to your flutter_application:

StartUserStoryConfiguration startUserStoryConfiguration = const StartUserStoryConfiguration();

and set the values as you wish.

Next add the StartUserStoryConfiguration to getStartStoryRoutes Like so:

List<GoRoute> getStartRoutes() => getStartStoryRoutes(
      startUserStoryConfiguration,
    );

Finally add the getStartRoutes to your Go_router routes like so:

final GoRouter _router = GoRouter(
  routes: <RouteBase>[
    ...getStartRoutes()
  ],
);

The routes that can be used to navigate are:

For routing to the SplashScreen:

  static const String splashScreen = '/splashScreen';

For routing to the Introduction:

  static const String introduction = '/introduction';

For routing to the HomeEntry:

  static const String home = '/home';

If you don't want a SplashScreen in your application set your initialRoute to Introduction:

final GoRouter _router = GoRouter(
  routes: <RouteBase>[
    ...getStartRoutes()
  ],
    initialLocation: '/introduction',
);

To use the module within your Flutter-application without predefined Go_router routes but with Navigator routes add the following :

Add the following configuration to your flutter_application:

StartUserStoryConfiguration startUserStoryConfiguration = const StartUserStoryConfiguration();

Add the following code to the build-method of a chosen widget:

startNavigatorUserStory(startUserStoryConfiguration, context);

If the splashScreenBuilder is not used the SplashScreen will be skipped.