formigas GoRouter Brick

A brick that provides the structure how we implement go_router at formigas in our Flutter projects.

Usage 🛠️

See BrickHub for usage instructions.

Requirements

For the brick to work, the Widget used as home route needs to be in a file named the same as the Widget but in snake_case.

The app.dart file must use the MaterialApp widget and the homeRoute must either be initialized directly in the constructor or as a variable inside this file.

If there is another widget than the MaterialApp the goRouter file is still created, but the app.dart file is not modified accordingly.

A valid app.dart file can look like this:

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:counter_app/common/theme/custom_themes.dart';
import 'package:counter_app/features/counter/counter_controller_implementation.dart';
import 'package:counter_app/features/counter/counter_view.dart';

class App extends StatelessWidget {
    const App({super.key});

    @override
    build(context) => MaterialApp(
        title: 'Counter App',
        home: home,
        theme: CustomTheme().light,
        darkTheme: CustomTheme().dark,
        themeMode: ThemeMode.light,
        supportedLocales: L10n.delegate.supportedLocales,
    );
}

Widget home = const CounterView(
            controller: CounterControllerImplementation(),
        );

Output 📦

├── app 
│   ├── view
│   │   └── app.dart(modified)
├── services
│   ├── navigation_service
│   │   └── go_router.dart

Dependencies

Following dependencies will be installed for this brick if not already present:

• go_router

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add formigas_go_router

# Install globally
mason add -g formigas_go_router

Usage 🚀

mason make formigas_go_router

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.53 <0.1.0"

0.1.1

Docs

• Add language tag to code snippets in README.md

0.1.0

Docs

• Improve documentation to reduce redundancy on BrickHub page

Initial Release

• Add go_router implementation structure for Flutter projects
• Include setup for app.dart modification
• Add go_router.dart file creation

MIT License

Copyright (c) 2024 formigas GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.