Advanced Topics

The Advanced Topics pages document APIs that build on the core concepts.

  • Results — NavigationKey.WithResult<R>, complete(value) and registerForNavigationResult. The Results page has three sub-pages for multi-step flows: embedded flows for short callback chains, managed flows for longer or branching sequences, and Flows in a ViewModel for a flow that draws its own UI around the steps.
  • View Models — by navigationHandle<MyKey>() inside a ViewModel, createEnroViewModel { } in a Composable, and state shared between destinations.
  • Animations — NavigationAnimations, per-element animations, predictive back and shared elements.
  • Testing — runEnroTest, EnroTestRule, TestNavigationHandle and the assertion functions.
  • Plugins — receive a callback when any destination is opened, becomes active or is closed. Used for analytics, telemetry and instance metadata.
  • Synthetic Destinations — a NavigationKey bound to a block of code instead of a screen. Used to call non-Enro APIs, redirect on a runtime condition, and choose between several destinations that return the same result type.
  • Path Bindings — @NavigationPath and NavigationPathBinding map URL paths to NavigationKeys for deep links and web URLs.
  • Interceptors — run code before an open, close or result, and continue, cancel or replace the operation.
  • Deep Links — open a destination from a URL, on Android and the web, with a backstack below the destination.
  • Saved State — how long state in remember, rememberSaveable, a ViewModel and SavedStateHandle is kept.
  • Dependency Injection — ViewModels created by a DI framework, with Koin and Metro as the examples.
  • Multi-Module Projects — feature modules that open screens from other feature modules without a module dependency.
  • Scenes — dialogs, overlays, custom scene strategies and scene decorators.

Table of contents

This site uses Just the Docs, a documentation theme for Jekyll.