jaspr_router 0.4.2

jaspr_router: ^0.4.2 copied to clipboard

Added Link component to simplify router-aware navigation.

The Link component lets the user navigate to another route by clicking or tapping on it. It uses client-side routing if possible and fall back to the default browser navigation if no Router component is present in the tree. It will render an accessible <a> element with a valid href, which means that things like right-clicking a Link work as you'd expect.

Fixed redirects on initial load.

Fixed proper handling of <base> path.

Added Static Site Generation support. Pages are automatically generated for each route.

Fixed bug where Router.of(context).matchList.title always returned null.

BREAKING Complete overhaul of the router package.

The router implementation is mainly adapted from the go_router package for Flutter.

Routing works by providing a set of routes to the router component. You can choose between a normal Route and a ShellRoute. A ShellRoute acts as a layout wrapper around the child routes.

Each Route takes a path which can contain parameters like '/users/:userId'.

Both Route and ShellRoute have a .lazy variant used for lazy-loading parts of the application.

  Router(routes: [
    // simple routes
    Route(path: '/', builder: (context, state) => HomePage()),
    Route(path: '/about', builder: (context, state) => AboutPage()),
    // route with a path parameter
    Route(path: '/users/:userId', builder: (context, state) => UserPage(id: state.pathParameters['userId'])),
    // nested routes
    Route(path: '/base', builder: (context, state) => BasePage(), routes: [
      // full location will be '/base/details'
      Route(path: 'details', builder: (context, state) => DetailsPage()),
    ]),
    // shell route
    ShellRoute(
      builder: (context, state, child) => CustomLayout(child: child),
      routes: [
        Route(path: '/dashboard', builder: (context, state) => DashboardPage()),
      ]     
    ),
    // lazy loaded route
    // this assumes a deferred import like "import 'posts.dart' deferred as posts;"
    Route.lazy(path: '/posts', builder: (context, state) => posts.Posts(), load: posts.loadLibrary),
    // lazy loaded shell route
    ShellRoute.lazy(
      builder: (context, state, child) => CustomLayout(child: child),
      load: () => someAsyncTask(),
      routes: [
        Route(path: '/data', builder: (context, state) => DataPage()),
      ]
    )     
  ]);

While the router docs are work in progress, you can refer to the go_router docs for some references (don't expect everything to work exactly the same, but the core concepts are similar).