rune_router #

go_router (go_router) bridge for the rune package. Registers GoRoute and GoRouter value builders plus a GoRouterApp widget wrapper on a RuneConfig so Rune source can declare routed navigation structure.

What the bridge adds #

Values (2) #

Widgets (1) #

Source-level imperatives (6, v0.2.0+) #

When the bridge is constructed with RouterBridge(router: myRouter), it also registers six prefixed imperatives on config.imperatives so Rune source can navigate without bouncing through host Dart:

The plain const RouterBridge() form keeps the v0.1.0 behavior: only widget + value builders are registered and navigation stays host-driven.

Requirements #

• Flutter >= 3.22
• Dart >= 3.4
• rune ^1.19.0
• go_router ^14.0.0

Install #

dependencies:
  rune: ^1.19.0
  rune_router: ^0.2.0

Usage #

import 'package:flutter/material.dart';
import 'package:rune/rune.dart';
import 'package:rune_router/rune_router.dart';

void main() {
  runApp(
    RuneView(
      config: RuneConfig.defaults()
          .withBridges(const [RouterBridge()]),
      source: r'''
        GoRouterApp(
          router: GoRouter(
            initialLocation: '/',
            routes: [
              GoRoute(
                path: '/',
                builder: (ctx, state) => Scaffold(
                  appBar: AppBar(title: Text('Home')),
                  body: Center(
                    child: ElevatedButton(
                      onPressed: 'go-settings',
                      child: Text('Settings'),
                    ),
                  ),
                ),
              ),
              GoRoute(
                path: '/settings',
                builder: (ctx, state) => Scaffold(
                  appBar: AppBar(title: Text('Settings')),
                  body: Center(child: Text('Hello from settings.')),
                ),
              ),
            ],
          ),
        )
      ''',
      onEvent: (name, [args]) {
        // Host handles navigation through a reference to the router.
      },
    ),
  );
}

Pass the router instance into data: and navigate from the host:

final router = GoRouter(/* ... */);
RuneView(
  data: {'router': router},
  source: "GoRouterApp(router: router)",
);
// Host-side: router.go('/settings');

Source-level navigation (v0.2.0+) #

Supply the GoRouter instance to RouterBridge and source can navigate directly:

final router = GoRouter(/* ... */);
final config = RuneConfig.defaults()
    .withBridges([RouterBridge(router: router)]);

RuneView(
  config: config,
  source: """
    ElevatedButton(
      onPressed: () => Router.go('/settings'),
      child: Text('Settings'),
    )
  """,
);

License #

MIT. See LICENSE.