setInitialRoutePath method

  1. @override
Future<void> setInitialRoutePath(
  1. RouteInformation configuration
)
override

Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.

This should configure the RouterDelegate so that when build is invoked, it will create a widget tree that matches the initial route.

By default, this method forwards the configuration to setNewRoutePath.

Consider using a SynchronousFuture if the result can be computed synchronously, so that the Router does not need to wait for the next microtask to schedule a build.

See also:

Implementation

@override
Future<void> setInitialRoutePath(RouteInformation configuration) async {
  // Wait until restore is ready
  await _restoreIsDone.future;

  // Check if URI needs navigation
  bool needsNavigate = configuration.uri.pathSegments.isNotEmpty;

  // If yes, navigate
  if (needsNavigate) {
    await super.setInitialRoutePath(configuration);
  }
}