Pakete, Repositories und App-Kategorien suchen

Paketdetailsv0.2.1-prerelease

riverpod_navigation

Flutter-Navigation mit Riverpod verwalten

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
14
Likes
27
Pub-Punkte
120

Paket installieren

flutter pub add riverpod_navigation

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

RiverpodNavigation ist ein Flutter-Paket, das die Navigation durch nahtlose Integration mit dem Riverpod-Zustandsverwaltungssystem vereinfacht. Es bietet einen reaktiven, typensicheren Ansatz zur Behandlung von Routen und Navigationsereignissen, wodurch Entwickler die App-Navigation deklarativ und effizient verwalten können. Durch die Nutzung der Abhängigkeitsinjektion und Zustandsverwaltung von Riverpod ermöglicht es eine klare Trennung der Verantwortlichkeiten zwischen Routing-Logik und UI-Komponenten. Das Paket unterstützt alle wichtigen Plattformen wie Android, iOS, Web, macOS, Windows und Linux und ist daher ideal für plattformübergreifende Anwendungen.

Anwendungsfälle

  • Deklarative Routenverwaltung
  • Plattformübergreifende Navigation
  • Reaktive Navigationsflüsse
  • zustandsgetriebene Routing
  • Integration mit Riverpod-State
  • Dynamische Routenverwaltung

Hauptmerkmale

  • Riverpod-gesteuerte Navigation
  • Typensichere Routendefinitionen
  • Reaktive Navigationsaktualisierungen
  • plattformunabhängiger Entwurf
  • Klare Trennung der Routing-Logik
  • Unterstützung für verschachtelte Navigator

Geeignet für

  • Entwickler, die Riverpod verwenden
  • Plattformübergreifende Flutter-Apps
  • Komplexe Navigations-Szenarien
  • Apps, die zustandsbewusste Routing erfordern
  • Teams, die wartbaren Code priorisieren
  • Projekte mit dynamischen Routenanforderungen

Hinweise

  • Erfahrung mit Riverpod erforderlich
  • Kann Boilerplate für einfache Apps erhöhen
  • Lernkurve für neue Benutzer
  • Eingeschränkte Dokumentation im Vergleich zu Alternativen
  • Nicht geeignet für nicht-Riverpod-Projekte
  • Mögliche Leistungseinbußen in großen Navigatoren

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

Navigation for Riverpod

Managing Flutter navigation with riverpod.

Usage

Bootstrap

Replace your root ProviderScope with a RiverpodNavigation widget with your routing hierarchy and give the provided delegate and parser to your MaterialApp.router factory.

  final routes = RouteDefinition(
      template: UriTemplate.parse('/'),
      builder: (context, entry) => MaterialPage(
        child: HomeLayout(),
      ),
      next: [
        RouteDefinition(
          template: UriTemplate.parse('/articles/:id'),
          builder: (context, entry) => MaterialPage(
            child: ArticleLayout(
              id: entry.parameters['id']!,
            ),
          ),
        ),
      ],
    );
    return RiverpodNavigation( // Replaces your root ProviderScope
      routes: routes,
      builder: (context, delegate, parser) => MaterialApp.router(
        title: 'Flutter Demo',
        routerDelegate: delegate,
        routeInformationParser: parser,
      ),
    );
Navigate
From a provider

A navigationProvider is exposed and can be used to read the current navigation state.

To access the underlying notifier that allows various actions, use the navigationProvider.notifier provider.

final myProvider = Provider<MyState>((ref) {
        final navigation = ref.watch(navigationProvider.notifier);
        return MyState(
            navigateToArticles: () {
                navigation.navigate(Uri.parse('/articles'))
            },
            pop: () {
                navigation.pop();
            }
        );
    },
);
From a BuildContext

The notifier can be accessed with the navigation extension method from the BuildContext.

@override
Widget build(BuildContext context) {
    return TextButton(
        child: Text('Articles'),
        onPressed: () {
            context.navigation.navigate(Uri.parse('/articles'))
        }
    );
}
Pop behaviour

To customize the behaviour of pops when navigating back, a PopBehavior callback can be provided to the RiverpodNavigation instance. The result indicates whether the current pop action should be updated, cancelled or auto (default behavior which simply replace the route with the parent one).

 RiverpodNavigation(
    popBehaviour: (notifier, stack) {
        if (stack.lastRoute?.key == Key('share-article')) {
          return PopResult.update(Uri.parse('/'));
        }
        return PopResult.auto();
      },
    // ...
 )
URI rewriting

The uri can be modified before they are processed by the router with the uriRewriter property. This can be useful for redirecting or normalizing uris.

 RiverpodNavigation(
    uriRewriter: (notifier, uri) {
        if (uri == Uri.parse('/home')) {
            return Uri.parse('/');
        }
        const publicPrefix = 'https://example.com';
        final stringUri = uri.toString();
        if (stringUri.startsWith(publicPrefix)) {
            return Uri.parse(stringUri.substring(publicPrefix.length);
        }
        return uri;
    },
    // ...
);

Kategorien

Abhängigkeiten

Abhängigkeiten 4 Einträge

Quell-Repository

Projekte, die dieses Paket verwenden

Noch keine Daten verfügbar.