go_router_auth #

A simple auth guard for GoRouter. Handles login redirect, public routes, loading state, and protected UI widgets.

Framework-agnostic — works with GetX, Riverpod, Bloc, or plain state management.

Features #

• ✅ Auto-redirect to login — when not authenticated
• ✅ Auto-redirect from login — to home when already logged in
• ✅ Public routes — whitelist routes that don't require auth
• ✅ Loading state — prevents redirects while checking auth on startup
• ✅ ChangeNotifier — GoRouter's refreshListenable updates automatically
• ✅ ProtectedRoute widget — conditionally show/hide protected UI
• ✅ AuthStateBuilder widget — switch UI based on auth state

Getting started #

dependencies:
  go_router_auth: ^0.1.0

flutter pub get

Usage #

1. Create the guard #

import 'package:go_router_auth/go_router_auth.dart';

final authGuard = AuthGuard(
  isLoggedIn: () => myAuthService.isLoggedIn,
  loginPath: '/login',
  homePath: '/dashboard',
  publicRoutes: ['/login', '/register', '/forgot-password'],
);

2. Wire to GoRouter #

final router = GoRouter(
  initialLocation: '/dashboard',
  redirect: authGuard.redirect,
  refreshListenable: authGuard,
  routes: [
    GoRoute(path: '/login', builder: (_, __) => LoginPage()),
    GoRoute(path: '/register', builder: (_, __) => RegisterPage()),
    GoRoute(path: '/dashboard', builder: (_, __) => DashboardPage()),
    GoRoute(path: '/profile', builder: (_, __) => ProfilePage()),
  ],
);

3. Set loading state (on app start) #

// While checking stored token
authGuard.setLoading(true);
await myAuthService.checkToken();
authGuard.setLoading(false);

4. Notify on login/logout #

// After successful login
await myAuthService.login(email, password);
authGuard.notify();  // GoRouter re-evaluates redirect → goes to homePath

// After logout
await myAuthService.logout();
authGuard.notify();  // GoRouter re-evaluates redirect → goes to loginPath

5. ProtectedRoute widget (conditional UI) #

ProtectedRoute(
  authGuard: authGuard,
  child: ProfileCard(user: user),
  unauthenticatedBuilder: (context) => LoginPromptCard(),
)

6. AuthStateBuilder widget (auth-based UI switching) #

AuthStateBuilder(
  authGuard: authGuard,
  authenticated: (context) => DashboardPage(),
  unauthenticated: (context) => LoginPage(),
  loading: (context) => SplashScreen(),
)

API #

AuthGuard #

Constructor #

ProtectedRoute #

AuthStateBuilder #

License #

MIT