Skip to content

Releases: skydoves/compose-nav-graph

0.1.0

12 Jun 06:05

Choose a tag to compare

The first public release of Compose Navigation Graph: a toolkit that statically extracts your Compose navigation graph and draws it as an interactive flow map, right inside Android Studio or IntelliJ IDEA.

Highlights

  • Annotations (compose-nav-graph-annotations): @NavDestination, @NavEdge, @NavPreview, and @NavGraphRoot describe your graph in code. Navigation 3 NavKey destinations are picked up automatically; Navigation 2 routes and plain Activities wire in through the same annotations.
  • Gradle plugin (com.github.skydoves.navgraph) + KSP processor: generateNavGraph statically extracts the graph and renders a device free Layoutlib thumbnail of every @NavPreview screen, with no emulator and no connected device. Kotlin Multiplatform and multi module projects merge into one graph.
  • IDE plugin (JetBrains Marketplace): the NavGraph Graph tool window with the interactive flow map, a Preview Gallery that renders every @Preview in your project, double click to source, and a drag to connect gesture that writes @NavEdge back into your code.
  • Navigation validation: navDump / navCheck keep a committed, human readable .nav baseline (modeled on apiDump / apiCheck) so navigation changes are reviewable in pull requests; navCheck is wired into check.
  • Exports: exportNavGraphHtml / exportNavGraphImage and exportPreviewGalleryHtml / exportPreviewGalleryImage produce standalone interactive HTML pages or PNGs for docs, PRs, and design reviews.

Setup

// build.gradle.kts
plugins {
    id("com.google.devtools.ksp") version "<matching your Kotlin version>"
    id("com.github.skydoves.navgraph") version "0.1.0"
}

See the README and the documentation for the full guide, and CHANGELOG.md for the complete release notes.

The attached compose-nav-graph-idea-0.1.0.zip is the IDE plugin, for installing from disk as an alternative to the Marketplace.