AutoRoute Generator

https://pub.dev/packages/auto_route_generator

Admin

AutoRoute Generator is a code generator for the AutoRoute library that automatically generates...

Tokens:593

Snippets:13

Trust Score:9.9

Update:6 months ago

Show doc for...

Tokens:

Raw

### Example pubspec.yaml Dependency

Source: https://pub.dev/packages/auto_route_generator/install

This is an example of how the auto_route_generator dependency will appear in your pubspec.yaml file after adding it.

```yaml
dependencies:
  auto_route_generator: ^10.5.0
```

--------------------------------

### Create Empty Shell Routes with auto_route_generator

Source: https://pub.dev/packages/auto_route_generator/changelog

Demonstrates how to create and navigate to empty shell routes using the EmptyShellRoute class. This feature allows for creating routes that act as shells for nested navigation without defining a specific page.

```dart
final BooksTab = EmptyShellRoute('BooksTab');
context.push(BooksTab());
```

--------------------------------

### Import auto_route_generator Utilities

Source: https://pub.dev/packages/auto_route_generator/install

Import these utility files into your Dart code to use the functionalities provided by the auto_route_generator package.

```dart
import 'package:auto_route_generator/build_utils.dart';
import 'package:auto_route_generator/builder.dart';
import 'package:auto_route_generator/utils.dart';
```

--------------------------------

### Define AppRouter Configuration

Source: https://pub.dev/packages/auto_route_generator/example

Initializes the router class by extending RootStackRouter and applying the @AutoRouterConfig annotation.

```dart
import 'package:auto_route/auto_route.dart';

@AutoRouterConfig()
class AppRouter extends RootStackRouter {
  @override
  List<AutoRoute> get routes => [
        /// routes go here
      ];
}
```

--------------------------------

### Add auto_route_generator to Dart Project

Source: https://pub.dev/packages/auto_route_generator/install

Use this command to add the auto_route_generator package as a dependency in your Dart project.

```bash
$ dart pub add auto_route_generator
```

--------------------------------

### Add auto_route_generator to Flutter Project

Source: https://pub.dev/packages/auto_route_generator/install

Use this command to add the auto_route_generator package as a dependency in your Flutter project.

```bash
$ flutter pub add auto_route_generator
```

Tokens:

Raw