compose-nav-graph

(★ 510)

⛵️ Compose Navigation Graph plugin for Android Studio that visualizes your entire app flow as an interactive map of rendered previews, typed arguments, and transitions.

  • .coderabbit.yaml
  • .editorconfig
  • .gitignore
  • build.gradle.kts
  • CHANGELOG.md
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE
  • mkdocs.yml
  • NOTICE
  • plugin-agent-guides.md
  • README.md
  • renovate.json
  • settings.gradle.kts

🚀 Installation Guide

1. Get the code
git clone https://github.com/skydoves/compose-nav-graph

Downloads the entire project code from GitHub to your computer.

cd compose-nav-graph

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
// settings.gradle.kts

Builds the project using Gradle.

// build.gradle.kts

Builds the project using Gradle.

./gradlew :app:generateNavGraph

Builds the project using Gradle.

./gradlew :app:generatePreviewGallery # render every @Preview into build/navgallery

Builds the project using Gradle.

./gradlew :app:exportNavGraphHtml # a standalone interactive HTML canvas

Builds the project using Gradle.

A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation