https://github.com/devmike01/chaicup
Generates routes for jetpack compose
https://github.com/devmike01/chaicup
android-app android-library jetpack-compose jetpack-navigation
Last synced: 9 months ago
JSON representation
Generates routes for jetpack compose
- Host: GitHub
- URL: https://github.com/devmike01/chaicup
- Owner: devmike01
- Created: 2023-07-13T15:52:33.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-17T23:47:10.000Z (over 2 years ago)
- Last Synced: 2025-01-10T18:24:28.549Z (over 1 year ago)
- Topics: android-app, android-library, jetpack-compose, jetpack-navigation
- Language: Kotlin
- Homepage:
- Size: 168 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chaicup
### How to use
Chaicup is a lightweight kotlin library that "automagically" generates routes based on your `composable` function's name or custom name.
##### Step 1
```groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
##### Step 2
Add this to your app level in `build.gradle`
```groovy
plugins {
...
id("com.google.devtools.ksp")
}
```
##### Step 3
Add these dependencies to your project
```kotlin
implementation("com.github.devmike01.Chaicup:annotations:1.3.0")
ksp("com.github.devmike01.Chaicup:compiler:1.3.0")
```
##### Step 4
Add this to your app level gradle file
```kotlin
kotlin.sourceSets.main {
kotlin.srcDirs(
file("$buildDir/generated/ksp/{BUILD_TYPE}/kotlin/io/devmike01"),
)
}
```
The `BUILD_TYPE` is your app build type. In typical case, it should be `release`, `debug` or any other build types.
### Implementation
- Add `@ChaiRoute` to your compose function.
- Build your project and the routes would be automagically generated for you
- All the routes are located inside `ChaiCupRoutes`
- If you add `@ChaiRoute` to your function called `BuildScreen()`, it would generate a route named `BUILDSCREEN`.
### Sample
```kotlin
@Composable
@ChaiRoute
fun Greeting(navController: NavController, name: String) {
...
}
@Composable
@ChaiRoute
fun Greeting02(name: String) {
...
}
```
It generates code snippet
```kotlin
object ChaiCupRoutes{
const val GREETING_ROUTE = "/io.devmike01.chaicup.Greeting"
const val GREETING02_ROUTE = "/io.devmike01.chaicup.Greeting02"
}
```
To see the generated codes, look at this directory: `../generated/ksp/release/` or `../generated/ksp/debug/`
### Milestone
- [ ] Add support for arguments in path
- [x] Use underscores to string together routes
- [x] Generate new routes from compose function
License
-------
```text
Copyright 2023 Oladipupo Gbenga
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.
```