Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x1nto/taxi
A simple Jetpack Compose navigator.
https://github.com/x1nto/taxi
android android-library android-navigation jetpack-compose jetpack-compose-navigation kotlin kotlin-android kotlin-library navigation
Last synced: 3 months ago
JSON representation
A simple Jetpack Compose navigator.
- Host: GitHub
- URL: https://github.com/x1nto/taxi
- Owner: X1nto
- License: apache-2.0
- Created: 2022-06-14T18:58:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-24T10:29:14.000Z (about 2 years ago)
- Last Synced: 2023-03-05T08:23:08.083Z (almost 2 years ago)
- Topics: android, android-library, android-navigation, jetpack-compose, jetpack-compose-navigation, kotlin, kotlin-android, kotlin-library, navigation
- Language: Kotlin
- Homepage:
- Size: 188 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Taxi
A small navigation library for Jetpack Compose with state saving, backstack and animations support.
# Quick Setup
## Installation
Add JitPack repository to root build.gradle
```kotlin
allprojects {
repositories {
...
maven(url = "https://jitpack.io")
}
}
```
Add Taxi dependency to app build.gradle
```kotlin
dependencies {
implementation("com.github.X1nto.taxi:taxi:1.3.0")
}
```
## Basic Usage
```kotlin
sealed interface AppDestination : Destination {
@Parcelize
object Home : AppDestination
@Parcelize
object Settings : AppDestination
}
@Composable
fun BackstackApp() {
val navigator = rememberBackstackNavigator(initial = AppDestination.Home)
BackHandler {
//Check if the navigator can pop
if (!navigator.pop()) {
finish() //Finish the activity if the backstack was empty
}
}
Taxi(
modifier = Modifier.filLMaxSize(),
navigator = navigator,
transitionSpec = { fadeIn() with fadeOut() }
) { destination ->
when (destination) {
is AppDestination.Home -> {
Home(onSettingsClick = {
navigator.push(AppDestination.Settings)
})
}
is AppDestination.Settings -> {
Settings(onBackClick = {
navigator.pop()
})
}
}
}
}
@Composable
fun NavbarApp() {
val navigator = rememberNavigator(initial = AppDestination.Home)
Scaffold(
modifier = Modifier.fillMaxSize(),
bottomBar = {
NavigationBar(modifier = Modifier.fillMaxWidth()) {
NavigationBarItem(
selected = navigator.currentDestination is AppDestination.Home,
onClick = {
navigator.replace(AppDestination.Home)
},
label = {
Text("Home")
}
)
NavigationBarItem(
selected = navigator.currentDestination is AppDestination.Settings,
onClick = {
navigator.replace(AppDestination.Settings)
},
label = {
Text("Settings")
}
)
}
}
) { paddingValues ->
Taxi(
modifier = Modifier.fillMaxSize().padding(paddingValues),
navigator = navigator,
transitionSpec = { fadeIn() with fadeOut() }
) { destination ->
when (destination) {
is AppDestination.Home -> {
Home()
}
is AppDestination.Settings -> {
Settings()
}
}
}
}
}
```
## Usage with Addresses
Taxi addresses simplify your code by providing a neat DSL for registering new destinations.
Add the addresses dependency to app build.gradle
```kt
dependencies {
...
implementation("com.github.X1nto.taxi:taxi-addresses:1.3.0")
}
```
Now use Taxi with a beautiful DSL:
```kt
AddressedTaxi(
modifier = Modifier.fillMaxSize().padding(paddingValues),
navigator = navigator,
transitionSpec = { fadeIn() with fadeOut() }
) {
address {
Home()
}
address {
Counter(it.count)
}
}
```
Check out the [sample app](/app) for better examples.
License
-------
```
Copyright (C) 2022 X1nto.
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
http://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.
```