https://github.com/roudikk/guia

Navigation Component for Jetpack Compose with support for screens, dialogs, bottomsheets, transitions and multi module projects
https://github.com/roudikk/guia

android android-library android-lifecycle android-navigation backstack bottom-navigation bottomsheet compose-navigation composer dialog jetpack-compose kotlin kotlin-android navigation navigation-component navigation-transitions navigator transition-animation type-safety viewpager

Last synced: 7 days ago
JSON representation

Navigation Component for Jetpack Compose with support for screens, dialogs, bottomsheets, transitions and multi module projects

• Host: GitHub
• URL: https://github.com/roudikk/guia
• Owner: roudikk
• License: apache-2.0
• Created: 2022-01-07T08:44:53.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-30T07:39:56.000Z (over 1 year ago)
• Last Synced: 2025-05-07T13:07:00.459Z (7 days ago)
• Topics: android, android-library, android-lifecycle, android-navigation, backstack, bottom-navigation, bottomsheet, compose-navigation, composer, dialog, jetpack-compose, kotlin, kotlin-android, navigation, navigation-component, navigation-transitions, navigator, transition-animation, type-safety, viewpager
• Language: Kotlin
• Homepage:
• Size: 126 MB
• Stars: 183
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Overview

Guia is a Navigation Library for Jetpack Compose.

Check out the [documentation on Gitbook](https://roudi.gitbook.io/guia-navigation/).

The motivation behind creating this library is to provide a simple, yet customizable API, for building multi module android navigation system with support for screens, dialogs, bottom sheets or any other representation of a UI.

Guia also has proper android Lifecycle, ViewModel and saved state support.

To get started, check the [Setup](https://roudi.gitbook.io/guia-navigation/setup) page.

For a comprehensive guide on how Guia works check [The Lore](https://roudi.gitbook.io/guia-navigation/using-guia/the-lore/), for a quick start and a small overview check [Express Lore](https://roudi.gitbook.io/guia-navigation/using-guia/express-lore/).

| Screens + BottomNav                                                                                                 | BottomSheest                                                                                                          | Dialogs                                                                                                           | Nested                                                                                                           | ViewPager + Stack                                                                                                         |

|---------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|

| ![viewmodel](https://user-images.githubusercontent.com/22520376/215367080-4c26d553-0e3b-4b0a-a713-9e9ccaddc154.png) | ![bottomsheet](https://user-images.githubusercontent.com/22520376/215367072-4acd062b-87e1-4f95-ba84-694e531e5171.png) | ![dialogs](https://user-images.githubusercontent.com/22520376/215367076-06613247-0ec8-40e1-9ab1-ce5d17f9666c.png) | ![nested](https://user-images.githubusercontent.com/22520376/215367077-f3d1feb3-1541-4bc2-b4ca-f746dfa7043c.png) | ![viewpager-stack](https://user-images.githubusercontent.com/22520376/215367083-1afa6fee-c0c8-43ca-8a0a-1c8982733e8f.png) |

_Guia \~ \[ˈɡia] feminine noun. Means guidance._