navigator
A small navigation library for Android to ease the use of fragment transactions & handling backstack (also available for Jetpack Compose).
File Explorer
Download Latest Version (.zip)- build-compose.yml
- build.yml
- codeStyleConfig.xml
- Project.xml
- Project_Default.xml
- .gitignore
- .name
- compiler.xml
- deploymentTargetDropDown.xml
- gradle.xml
- jarRepositories.xml
- kotlinc.xml
- misc.xml
- vcs.xml
- gradle-wrapper.jar
- gradle-wrapper.properties
- publish.gradle
- root.gradle
- navigator.api
- BasicMultiStackTests.kt
- FragmentNavigatorTests.kt
- BackStackRecord.kt
- CustomAnimation.kt
- Extensions.kt
- HistoryImpl.kt
- NavigatorCircularTransform.kt
- SharedElementsTransition.kt
- StateViewModel.kt
- ViewStateFragment.kt
- AnimationDefinition.kt
- BaseArgs.kt
- Destination.kt
- FragmentExtensions.kt
- FragmentNavigator.kt
- History.kt
- SimpleNavigator.kt
- ValueFragment.kt
- navigator_fade_in.xml
- navigator_fade_out.xml
- navigator_slide_in_bottom.xml
- navigator_slide_in_left.xml
- navigator_slide_in_right.xml
- navigator_slide_in_top.xml
- navigator_slide_out_bottom.xml
- navigator_slide_out_left.xml
- navigator_slide_out_right.xml
- navigator_slide_out_top.xml
- navigator_scale_in_gone.xml
- navigator_scale_in_visible.xml
- navigator_scale_out_gone.xml
- navigator_scale_out_visible.xml
- navigator_change_transform.xml
- navigator_transition_fade.xml
- custom.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- navigator-base-navigation.api
- CustomNavigations.kt
- Fragments.kt
- BaseNavigationTests.kt
- MultipleBackStackTests.kt
- PrimaryNavigationTest.kt
- activity_main.xml
- CommonLifecycleCallbacks.kt
- CommonLifecycleImpl.kt
- CommonNavigationImpl.kt
- Customs.kt
- attrs.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- navigator-bottom-navigation.api
- dummy
- BottomNavigationImpl.kt
- Customs.kt
- BottomNavigation.kt
- BottomNavigationController.kt
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- codeStyleConfig.xml
- Project.xml
- Project_Default.xml
- .gitignore
- .name
- compiler.xml
- jarRepositories.xml
- vcs.xml
- gradle-wrapper.jar
- gradle-wrapper.properties
- navigator-compose.api
- Extensions.kt
- GalleryList.kt
- MainActivity.kt
- MultipleStack.kt
- Routes.kt
- ViewModelScreen.kt
- ComposeNavigatorTests.kt
- strings.xml
- AndroidManifest.xml
- ComposeNavigator.kt
- DefaultTransitions.kt
- AndroidManifest.xml
- Routes.kt
- ComposeNavigatorUnitTests.kt
- .gitignore
- build.gradle
- consumer-rules.pro
- navigator-compose-hilt.api
- App.kt
- MainActivity.kt
- HiltViewModelTest.kt
- strings.xml
- AndroidManifest.xml
- HiltViewModel.kt
- AndroidManifest.xml
- .gitignore
- build.gradle
- consumer-rules.pro
- RouteDetector.kt
- ComposeNavigatorIssueRegistry.kt
- com.android.tools.lint.client.api.IssueRegistry
- Stubs.kt
- RouteSealedClassTest.kt
- .gitignore
- build.gradle
- UnifiedTests.kt
- BottomSheet.kt
- CommonItem.kt
- Menu.kt
- MainFirstScreen.kt
- MainFirstThirdHome.kt
- MainFirstThirdScreen.kt
- MainScreen.kt
- MainSecondScreen.kt
- MenuFavouriteScreen.kt
- MenuHomeScreen.kt
- MenuSettingScreen.kt
- Color.kt
- Shape.kt
- Theme.kt
- Type.kt
- HiltTestViewModel.kt
- App.kt
- CustomTransitions.kt
- MainActivity.kt
- ic_launcher_background.xml
- placeholder.png
- ic_launcher_foreground.xml
- ic_launcher.xml
- ic_launcher_round.xml
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- colors.xml
- strings.xml
- themes.xml
- themes.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- compose-samples
- .gitignore
- build.gradle
- CHANGELOG.md
- gradle.properties
- gradlew
- gradlew.bat
- LICENSE
- README.md
- run_test.sh
- settings.gradle
- navigator-extensions.api
- dummy
- NavigatorExtensions.kt
- AndroidManifest.xml
- ExampleUnitTest.kt
- .gitignore
- build.gradle
- NavigatorDetector.kt
- Extensions.kt
- IssueRegistry.kt
- IssueRegistry
- Stubs.kt
- FragmentNavigatorIssueTest.kt
- .gitignore
- build.gradle
- navigator-rail-navigation.api
- Customs.kt
- RailNavigationImpl.kt
- RailNavigation.kt
- RailNavigationController.kt
- AndroidManifest.xml
- .gitignore
- build.gradle
- consumer-rules.pro
- proguard-rules.pro
- navigator-tab-navigation.api
- Customs.kt
- TabNavigationImpl.kt
- TabNavigation.kt
- TabNavigationController.kt
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- Extensions.kt
- Fragments.kt
- TestMainActivity.kt
- activity_main.xml
- fragment_abstract.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- anchor-copy-button.svg
- arrow_down.svg
- copy-icon.svg
- copy-successful-icon.svg
- footer-go-to-link.svg
- go-to-top-icon.svg
- logo-icon.svg
- theme-toggle.svg
- -circular-reveal.html
- from-target.html
- index.html
- -custom.html
- current-exiting.html
- current-returning.html
- destination-entering.html
- destination-exiting.html
- index.html
- index.html
- index.html
- -shared.html
- current-exiting.html
- destination-entering.html
- elements.html
- index.html
- shared-element-entering.html
- shared-element-exiting.html
- index.html
- index.html
- index.html
- index.html
- index.html
- index.html
- -base-args.html
- index.html
- index.html
- of.html
- -destination.html
- fragments.html
- index.html
- -bottom-navigation.html
- bottom-navigation-fragments.html
- bottom-navigation-view-id.html
- index.html
- on-bottom-navigation-selection-changed.html
- index.html
- index.html
- initialize.html
- index.html
- with.html
- -nav-options.html
- animation.html
- args.html
- history-options.html
- index.html
- remember.html
- transaction.html
- index.html
- index.html
- index.html
- index.html
- -animation.html
- enter.html
- exit.html
- index.html
- index.html
- on-reselected.html
- on-selected.html
- index.html
- index.html
- index.html
- index.html
- index.html
- index.html
- index.html
- -navigation.html
- fragment-navigation-transition.html
- fragment-view-retention-type.html
- index.html
- selected-fragment-id.html
- -rail-navigation.html
- index.html
- on-rail-navigation-selection-changed.html
- rail-navigation-fragments.html
- rail-navigation-view-id.html
- -tab-navigation.html
- index.html
- on-tab-navigation-selection-changed.html
- tab-layout-id.html
- tab-navigation-fragments.html
- index.html
- index.html
- index.html
- get-navigator.html
- index.html
- can-go-back.html
- get-container-view.html
- get-current-fragment.html
- get-fragment-manager.html
- get-history.html
- go-back.html
- index.html
- navigate-to.html
- show.html
- clear-all.html
- clear-up-to.html
- count.html
- get-all-back-stack-name.html
- get-back-stack-name.html
- get-top-back-stack-name.html
- index.html
- is-empty.html
- pop.html
- index.html
- index.html
- -pop-to-back-stack.html
- inclusive.html
- index.html
- name.html
- -pop-to-fragment.html
- all.html
- clazz.html
- index.html
- index.html
- index.html
- index.html
- index.html
- index.html
- pop.html
- show.html
- create-arg-key.html
- index.html
- -value-fragment.html
- force-back-press.html
- go-back.html
- index.html
- on-back-pressed.html
- on-save-instance-state.html
- on-stop.html
- on-view-created.html
- parent-navigator.html
- simple-navigator.html
- clear-args.html
- get-key-args.html
- has-key-args.html
- index.html
- index.html
- index.html
- index.html
- index.html
- index.html
- on-destroy-view.html
- on-view-created.html
- on-view-state-changed.html
- index.html
- index.html
- navigation.html
- index.html
- select.html
- index.html
- install.html
- index.html
- navigation.html
- auto-child-elevation.html
- can-finish.html
- index.html
- index.html
- navigation.html
- index.html
- select.html
- index.html
- install.html
- index.html
- navigation.html
- index.html
- select.html
- index.html
- install.html
- index.html
- navigation.html
- clipboard.js
- main.js
- navigation-loader.js
- pages.json
- platform-content-handler.js
- prism.js
- sourceset_dependencies.js
- jetbrains-mono.css
- logo-styles.css
- main.css
- prism.css
- style.css
- index.html
- navigation.html
- package-list
- anchor-copy-button.svg
- arrow_down.svg
- copy-icon.svg
- copy-successful-icon.svg
- footer-go-to-link.svg
- go-to-top-icon.svg
- logo-icon.svg
- theme-toggle.svg
- disable-default-back-press-logic.html
- disable-on-save-state-instance.html
- index.html
- initialize.html
- register-transitions.html
- index.html
- with.html
- -create-dialog.html
- can-go-back.html
- close-dialog.html
- current-route.html
- enable-dialog-overlay.html
- get-all-dialog-history.html
- get-all-history.html
- get-current-route-as-flow.html
- go-back-to-root.html
- go-back-until.html
- go-back.html
- index.html
- navigate-to.html
- parent-route.html
- show-dialog.html
- dialog-navigator.html
- dialog-route.html
- dismiss.html
- go-back.html
- index.html
- -setup.html
- can-go-back.html
- get-all-history.html
- get-all-keys.html
- get-history.html
- go-back-to-root.html
- go-back-until.html
- go-back.html
- index.html
- on-save-instance-state.html
- index.html
- invoke.html
- index.html
- get-lifecycle.html
- get-saved-state-registry.html
- get-view-model-store.html
- index.html
- -nav-animation.html
- current.html
- index.html
- target.html
- -pop-up-options.html
- all.html
- inclusive.html
- index.html
- -nav-options.html
- index.html
- pop-up-to.html
- single-top.html
- with-animation.html
- -navigator-transition.html
- animation-spec.html
- backward-transition.html
- forward-transition.html
- index.html
- key.html
- index.html
- key.html
- index.html
- lifecycle-controller.html
- -transition-key.html
- index.html
- -unstable-navigator-api.html
- index.html
- -fade.html
- -none.html
- -slide-left.html
- -slide-right.html
- find-compose-navigator.html
- find-nav-controller.html
- index.html
- remember-nav-controller.html
- index.html
- navigation.html
- get-factory.html
- index.html
- hilt-view-model.html
- index.html
- index.html
- navigation.html
- clipboard.js
- main.js
- navigation-loader.js
- pages.json
- platform-content-handler.js
- prism.js
- sourceset_dependencies.js
- jetbrains-mono.css
- logo-styles.css
- main.css
- prism.css
- style.css
- index.html
- navigation.html
- package-list
- demo1.gif
- demo2.gif
- Extensions.kt
- Fragments.kt
- MainActivity.kt
- ic_launcher_background.xml
- ic_launcher_foreground.xml
- activity_main.xml
- fragment_disclaimer.xml
- ic_launcher.xml
- ic_launcher_round.xml
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- colors.xml
- strings.xml
- themes.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- README.md
- Extensions.kt
- Fragments.kt
- MainActivity.kt
- ic_baseline_arrow_back_24.xml
- ic_launcher_background.xml
- ic_launcher_foreground.xml
- activity_main.xml
- fragment_common.xml
- ic_launcher.xml
- ic_launcher_round.xml
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- myfade.xml
- colors.xml
- strings.xml
- themes.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- Navigate.kt
- SomeDependency.kt
- attr.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- consumer-rules.pro
- proguard-rules.pro
- HomeModules.kt
- HomeQualifier.kt
- HomeStartFragment.kt
- HomeStartViewModel.kt
- HomeButtonClickedImpl.kt
- HomeDependency.kt
- HomeFragment.kt
- fragment_home.xml
- fragment_home_start.xml
- strings.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- consumer-rules.pro
- proguard-rules.pro
- HomeInternalWorker.kt
- HomeButtonClicked.kt
- HomeInternalFragment.kt
- fragment_home_internal.xml
- strings.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- consumer-rules.pro
- proguard-rules.pro
- HomeInternal2Fragment.kt
- fragment_home_internal2.xml
- strings.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- consumer-rules.pro
- proguard-rules.pro
- ActivityModule.kt
- WelcomeButtonClickImpl.kt
- App.kt
- MainActivity.kt
- ic_launcher_background.xml
- ic_launcher_foreground.xml
- activity_main.xml
- content_main.xml
- ic_launcher.xml
- ic_launcher_round.xml
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- ic_launcher.webp
- ic_launcher_round.webp
- colors.xml
- dimens.xml
- strings.xml
- themes.xml
- dimens.xml
- themes.xml
- dimens.xml
- dimens.xml
- backup_rules.xml
- data_extraction_rules.xml
- AndroidManifest.xml
- WelcomeButtonClick.kt
- WelcomeFragment.kt
- fragment_welcome.xml
- strings.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- consumer-rules.pro
- proguard-rules.pro
- .gitignore
- build.gradle
- proguard-rules.pro
- README.md
- ChildFragments.kt
- Extensions.kt
- HomeFragment.kt
- MainActivity.kt
- MainFragment.kt
- SettingFragment.kt
- ic_baseline_backup_24.xml
- ic_baseline_home_24.xml
- ic_baseline_menu_24.xml
- ic_baseline_settings_24.xml
- ic_launcher_background.xml
- ic_launcher_foreground.xml
- activity_main.xml
- fragment_abstract.xml
- fragment_home.xml
- fragment_main.xml
- fragment_second.xml
- fragment_setting.xml
- nav_menu.xml
- ic_launcher.xml
- ic_launcher_round.xml
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- ic_launcher.png
- ic_launcher_round.png
- attrs.xml
- colors.xml
- strings.xml
- themes.xml
- AndroidManifest.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- .gitattributes
- .gitignore
- .gitmodules
- build.gradle
- CHANGELOG.md
- docs
- gradle.properties
- gradlew
- gradlew.bat
- LICENSE
- README.md
- settings.gradle
# Installation Guide
1. Get the code
git clone https://github.com/KaustubhPatange/navigator
Downloads the entire project code from GitHub to your computer.
cd navigator
Moves into the project folder you just downloaded.
2. Gradle (Java/Kotlin)
Medium RecommendedPrerequisites
- 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.
// root's build.gradle
Builds the project using Gradle.
// modules's build.gradle
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
Was this content helpful?
(0 ratings)
