
# All properties

Every property `spring_boot_starter_flutter_navigation` reads, under `spring.flutter.navigation`. Some are read when the app starts; the deep link keys are read by `spring_core_dart_generator` at build time, which writes the platforms' files from them.

## Why

The navigation is mostly code (screens and shells), but where the app starts, where a guard sends people, the languages and the deep links are configuration: they differ per platform, per build or per customer. This page lists them in one place. The starter's metadata describes the same keys for editors.

## Example

```yaml
# lib/resources/application.yml
spring:
  flutter:
    navigation:
      initial: /catalog
      login: /login
      redirects:
        "[/home]": /catalog
      languages: [en, ja]
      web:
        url-strategy: path
      deep-links:
        scheme: neonbooks
        domains: [books.example.com]
        exclude: [/checkout, /admin/**]
```

```properties
# lib/resources/application.properties: the same
spring.flutter.navigation.initial=/catalog
spring.flutter.navigation.login=/login
spring.flutter.navigation.redirects[/home]=/catalog
spring.flutter.navigation.languages=en,ja
spring.flutter.navigation.web.url-strategy=path
spring.flutter.navigation.deep-links.scheme=neonbooks
spring.flutter.navigation.deep-links.domains[0]=books.example.com
spring.flutter.navigation.deep-links.exclude[0]=/checkout
spring.flutter.navigation.deep-links.exclude[1]=/admin/**
```

A key of `redirects` is a path, so it is written in brackets: `[/home]` (in YAML in quotes too).

## spring.flutter.navigation

| Key | Type | Default | Read | Meaning | Page |
|---|---|---|---|---|---|
| `spring.flutter.navigation.initial` | path | none | at the start | Where the app starts when the platform gives `/` (no deep link, the site's root), such as `/catalog` | [Screens](screens.md#where-the-app-starts) |
| `spring.flutter.navigation.login` | path | none | at the start | Where a guarded screen sends nobody logged in; the app comes back after the login. Without it, such a navigation shows the error screen | [Guards](filters-and-guards.md#guarded-screens) |
| `spring.flutter.navigation.redirects.<from>` | path | none | at the start | An address that leads to another (`"[/]": /catalog`); a route's own redirect of the same path wins | [Screens](screens.md#where-the-app-starts) |
| `spring.flutter.navigation.languages` | list of language tags | none (one language, no prefix) | at the start and by the generator | The languages with their own addresses: the first is the default, without a prefix; the others under `/<language>`. The build writes the pages for search engines in each | [Languages](languages.md) |
| `spring.flutter.navigation.web.url-strategy` | `path`, `hash` | `path` | at the start | `/catalog/books/1`, or Flutter's `/#/catalog/books/1` | [The web](web-and-deep-links.md#addresses-in-a-browser) |

## spring.flutter.navigation.deep-links

| Key | Type | Default | Read | Meaning |
|---|---|---|---|---|
| `spring.flutter.navigation.deep-links.enabled` | bool | `true` | by the generator | Whether the deep links are written; `false` in a platform's profile turns them off there |
| `spring.flutter.navigation.deep-links.scheme` | URL scheme | none | by the generator | The app's own scheme; not verified, another app may claim it |
| `spring.flutter.navigation.deep-links.domains` | list of host names | none | by the generator | The domains whose `https` links open the app (Universal Links, App Links) |
| `spring.flutter.navigation.deep-links.exclude` | list of path patterns (Spring's syntax) | none | at the start and by the generator | Addresses a link does not open; the app opens its first screen instead |
| `spring.flutter.navigation.deep-links.app-id` | `TEAMID.bundle.id` | from the Xcode project | by the generator | The iOS app id of `apple-app-site-association` |
| `spring.flutter.navigation.deep-links.package` | Android package | the Gradle file's `applicationId` | by the generator | The package of `assetlinks.json` |
| `spring.flutter.navigation.deep-links.sha256-cert-fingerprints` | list | none | by the generator | The SHA-256 fingerprints of the Android signing keys; without them `assetlinks.json` is not written |

See [The web and deep links](web-and-deep-links.md) for the files written.

## Keys of other starters the navigation follows

| Key | Starter | Meaning |
|---|---|---|
| `spring.flutter.app.type` | Flutter | `MaterialApp.router` (with `spring_boot_starter_flutter_material`), `CupertinoApp.router` (with `spring_boot_starter_flutter_cupertino`) or `WidgetsApp.router` |
| `spring.flutter.theme.motion.page-transition` | Flutter | The transition of every screen (see [Transitions](transitions.md)) |
| `spring.flutter.theme.motion.scroll-to-top`, `motion.content-change` | Flutter | How `RouteContentView` changes pages (see [Markdown screens](markdown-screens.md)) |
| `spring.flutter.web.seo.from-routes` | Flutter | A page per route for search engines (see [SEO](../spring-boot-starter-flutter/seo.md)) |

## See also

- [Overview](index.md)
- [All properties of spring_boot_starter_flutter](../spring-boot-starter-flutter/properties.md)
- [Properties the build reads](../spring-core-dart-generator/build-properties.md)
