https://github.com/csells/go_router

The purpose of the go_router for Flutter is to use declarative routes to reduce complexity, regardless of the platform you're targeting (mobile, web, desktop), handling deep linking from Android, iOS and the web while still allowing an easy-to-use developer experience.
https://github.com/csells/go_router

flutter navigation router routing

Last synced: 3 months ago
JSON representation

The purpose of the go_router for Flutter is to use declarative routes to reduce complexity, regardless of the platform you're targeting (mobile, web, desktop), handling deep linking from Android, iOS and the web while still allowing an easy-to-use developer experience.

• Host: GitHub
• URL: https://github.com/csells/go_router
• Owner: csells
• Archived: true
• Created: 2021-05-23T05:52:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-25T00:38:31.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T12:27:11.214Z (6 months ago)
• Topics: flutter, navigation, router, routing
• Language: Dart
• Homepage: https://gorouter.dev
• Size: 15.9 MB
• Stars: 441
• Watchers: 11
• Forks: 96
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# go_router is now published and maintained by the Flutter team

As of the 3.0.2 release, [the go_router package](https://pub.dev/packages/go_router) is published by the Flutter team and maintained by Flutter engineering in [the flutter/packages repository](https://github.com/flutter/packages/tree/main/packages/go_router).

Existing go_router issues have been moved to [the flutter issues list](https://github.com/flutter/flutter/issues) and new go_router-related issues should be filed there.

The docs on [gorouter.dev](https://gorouter.dev) will also be moving to [docs.flutter.dev](https://docs.flutter.dev) over time.

This repo has been archived and is read-only.

[![Pub

Version](https://img.shields.io/pub/v/go_router?label=go_router&labelColor=333940&logo=dart)](https://pub.dev/packages/go_router)

![Test](https://github.com/csells/go_router/workflows/validate/badge.svg)

[![codecov](https://codecov.io/gh/csells/go_router/branch/master/graph/badge.svg?token=4XJU30IGO3)](https://codecov.io/gh/csells/go_router)

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

# Welcome to go_router!

The purpose of [the go_router package](https://pub.dev/packages/go_router) is to

use declarative routes to reduce complexity, regardless of the platform you're

targeting (mobile, web, desktop), handle deep and dynamic linking from

Android, iOS and the web, along with a number of other navigation-related

scenarios, while still (hopefully) providing an easy-to-use developer

experience.

You can get started with go_router with code as simple as this:

```dart

class App extends StatelessWidget {

  App({Key? key}) : super(key: key);

  @override

  Widget build(BuildContext context) => MaterialApp.router(

        routeInformationParser: _router.routeInformationParser,

        routerDelegate: _router.routerDelegate,

        title: 'GoRouter Example',

      );

  final _router = GoRouter(

    routes: [

      GoRoute(

        path: '/',

        builder: (context, state) => const Page1Screen(),

      ),

      GoRoute(

        path: '/page2',

        builder: (context, state) => const Page2Screen(),

      ),

    ],

  );

}

class Page1Screen extends StatelessWidget {...}

class Page2Screen extends StatelessWidget {...}

```

But go_router can do oh so much more!

# See [gorouter.dev](https://gorouter.dev) for go_router docs & samples