Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaustubhpatange/navigator
A small navigation library for Android to ease the use of fragment transactions & handling backstack (also available for Jetpack Compose).
https://github.com/kaustubhpatange/navigator
android animations backstack bottom-navigation fragment-transitions fragments jetpack-compose navigation process-death single-activity-pattern state-persistence tablayout-navigation
Last synced: about 2 months ago
JSON representation
A small navigation library for Android to ease the use of fragment transactions & handling backstack (also available for Jetpack Compose).
- Host: GitHub
- URL: https://github.com/kaustubhpatange/navigator
- Owner: KaustubhPatange
- License: apache-2.0
- Created: 2021-04-11T16:34:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-14T10:23:29.000Z (over 1 year ago)
- Last Synced: 2024-08-02T19:38:57.166Z (5 months ago)
- Topics: android, animations, backstack, bottom-navigation, fragment-transitions, fragments, jetpack-compose, navigation, process-death, single-activity-pattern, state-persistence, tablayout-navigation
- Language: Kotlin
- Homepage:
- Size: 1.63 MB
- Stars: 98
- Watchers: 4
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# navigator
> **Looking for Jetpack Compose implementation of `navigator`, see [here](navigator-compose)**.
A small (Kotlin first) type-safe 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](/samples/backpress-sample).
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](/samples/basic-sample).
- Easy to use API for animations & transitions (see [here](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigation-with-animation)).
- Generic Typed Arguments when passing data between destinations (see [here](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigation-with-typed-arguments)).
- Quick Bottom & Tab navigation setup (see [tutorials](#tutorials)).
API Reference docs, check [here](https://kaustubhpatange.github.io/navigator/reference/navigator).
## Implementation
```groovy
// root's build.gradle
allprojects {
repositories {
mavenCentral()
}
}
```
```groovy
// modules's build.gradle
dependencies {
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.
}
```
- #### Snapshots
Snapshots of the current development version of `navigator` are available, which track the latest commit. See [here](https://github.com/KaustubhPatange/navigator/wiki/Using-a-Snapshot-Version) for more information.
## Samples
- [Basic sample](/samples/basic-sample) - Hands on with the introduction to some library features.
- [Backpress sample](/samples/backpress-sample) - A sample focused on handling back press events effectively.
- [Navigation sample](/samples/navigation-sample) - A sample which demonstrate the use of Bottom & Tab navigation supporting multiple backstack through `navigator`.
- [Multi-Module Navigation sample](/samples/multi-module-sample) - Multi-module navigation through `navigator` using Dagger-Hilt.
## Tutorials
- [Quick Setup & usage]()
- [Hands on Tutorials](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials)
- [Navigate to a Fragment](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigate-to-fragment)
- [Navigate to a Fragment but remember the transaction](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigate-to-a-Fragment-but-remember-the-transaction)
- [Navigation with typed arguments](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigation-with-typed-arguments)
- [Navigation with animation](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigation-with-animation)
- [Navigation with single top instance or `popUpTo`](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigation-with-single-top-instance-or-popUpTo)
- [Navigate to a BottomSheet or Dialog Fragment](https://github.com/KaustubhPatange/navigator/wiki/Quick-Tutorials#navigate-to-a-bottomSheet-or-dialog-fragment)
- [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**](https://kaustubhpatange.github.io/Moviesy) - Client app for YTS movies |
| 
| [**XClipper**](https://github.com/KaustubhPatange/XClipper) - Clipboard manager for Android & Windows |
## License
- [The Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
```
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.
```