navigator
Looking for Jetpack Compose implementation of
navigator, see here.
A small (Kotlin first) navigation library for Android to ease the use of fragment transactions with a navigator.navigateTo call (rest is handled for you) & navigating back is as simple as navigator.goBack().
You also get a separate onBackPressed() callback on the child fragments which will be called when this is the current visible fragment & is the one which is going to be removed upon back press.
The library provides some custom transitions like CircularTransform (on top of existing animations), see its use in the sample app here.
If you have any implementation details to cover let me know.
What additional benefits I can get when using this library?
- Proper handling of Fragment Transaction.
- Handling up & back press actions efficiently on Fragment.
- Easy to use API for animations & transitions (see here).
- Generic Typed Arguments when passing data between destinations (see here).
- Quick Bottom & Tab navigation setup (see tutorials).
Implementation
- The individual library versions can be found here.
// root's build.gradle
allprojects {
repositories {
mavenCentral()
}
}
// modules's build.gradle dependencies { // Check the above link for the individual library versions. implementation "io.github.kaustubhpatange:navigator:" // Core library (Required) implementation "io.github.kaustubhpatange:navigator-extensions:" // Optional but recommended implementation "io.github.kaustubhpatange:navigator-bottom-navigation:" // For setting up Bottom Navigation. implementation "io.github.kaustubhpatange:navigator-tab-navigation:" // For setting up Tab Layout Navigation. implementation "io.github.kaustubhpatange:navigator-rail-navigation:" // For setting up Rail Navigation. }
Samples
- Basic sample - Hands on with the introduction to some library features.
- Backpress sample - A sample focused on handling back press events effectively.
- Navigation Sample - A sample which demonstrate the use of Bottom & Tab navigation supporting multiple backstack through
navigator. -
Running the samples
// Run the following command before building the project.
./gradlew navigator:publishReleasePublicationToMavenLocal
Tutorials
- Quick Setup & usage
- Hands on Tutorials
- Bottom navigation setup
- TabLayout navigation setup
- Rail navigation setup
Apps using navigator
If you would like me to add your app in the list, let me know through issues.
| Name | |
|---|---|
 |
Moviesy - Client app for YTS movies |
 |
XClipper - Clipboard manager for Android & Windows |
License
Copyright 2020 Kaustubh Patange
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
![There are some problems when using the [FragmentNavigator.TransactionType.ADD], Why?](https://avatars.githubusercontent.com/u/57759182?v=4)
![[Navigator Compose] Nested navigation does not save saveables in `SaveableStateHolder` across process death.](https://avatars.githubusercontent.com/u/22119598?v=4)
21 Feb 6, 2021
1.3k Jan 2, 2023
3 Sep 28, 2022
2 Dec 22, 2022
1 Jul 11, 2022
0 Nov 3, 2021
290 Dec 29, 2022
278 Nov 22, 2022
1 Jan 26, 2022
21 Dec 10, 2022
5 Nov 24, 2022
6 Feb 3, 2022
4 Nov 30, 2022
3 Jul 27, 2022
290 Dec 9, 2022
4 Jun 15, 2022
831 Dec 26, 2022
5 Dec 26, 2021