routes/flutter_nav_kit library

flutter_nav_kit – a type-safe, animated navigation package for Flutter.

Quick-start

// 1. Declare your routes
class Routes extends NavRoutes {
  static const home   = '/home';
  static const detail = '/detail';

  @override
  List<String> get all => [home, detail];
}

// 2. Wire up the generator
MaterialApp(
  onGenerateRoute: NavRouteGenerator(
    routes: Routes(),
    noRouteScreen: const NotFoundScreen(),
    firstRoute: Routes.home,
    builders: {
      Routes.home:   (_) => const HomeScreen(),
      Routes.detail: (args) => DetailScreen(args: args),
    },
  ).generateRoute,
)

// 3. Navigate
NavKit.push(context, Routes.home);
NavKit.pushWithSlideUp(context, Routes.detail, arguments: item);

Classes

BaiomyNavKit

Primary navigation facade for flutter_nav_kit.

NavRouteGenerator

Generates Route objects from route settings.

NavRoutes

Base class for declaring application route names.

NavTransitionParams

Parsed transition configuration extracted from route arguments.

NavTransitions

Builds animated page transitions and provides default durations.

Enums

NavTransitionType

The animation style used when pushing a new route.

Extensions

NavKitContext on BuildContext

Convenience extensions on BuildContext for common navigation actions.

Functions

buildTransitionArgs({required Object? originalArguments, required NavTransitionType transitionType, Duration? transitionDuration, Duration? reverseTransitionDuration}) → Map<String, dynamic>

Wraps the caller's arguments together with transition metadata.