KRouter

Find interface implementation by uri string.

For Kotlin module to module communication.

The main purpose is to open the compose screen from other modules(e.g. Voyager).

Base on ServiceLoader, KSP and Kotlin reflect.

Usage

Firstly, define a interface.

interface Screen

After that, define some implementation.

@Destination("screen/home")
class HomeScreen(@Router val router: String = "") : Screen

@Destination("screen/profile")
class ProfileScreen : Screen {
    @Router
    lateinit var router: String
}

This implementation can be distributed to any modules.

Note that Destination class must have a No-Arg constructor.

Now, you can route to any Screen by router.

val homeScreen = KRouter.route<Screen>("screen/home?name=zhangke")
val profileScreen = KRouter.route<Screen>("screen/profile?name=zhangke")

As show above, you will get homeScreen, and it's router property is screen/home?name=zhangke.

See the sample.app module for a more detailed example.

Integration

Firstly, you must set up KSP in your project.

Then, add KRouter dependency in module.

// module's build.gradle.kts
implementation("com.github.0xZhangKe.KRouter:core:0.1.6")
ksp("com.github.0xZhangKe.KRouter:compiler:0.1.6")

Additionally, add resources dir in source sets.

// module's build.gradle.kts
kotlin {
    sourceSets.main {
        resources.srcDir("build/generated/ksp/main/resources")
    }
}

@Destination

Destination annotation is defined for a route Destination.

It's having two parameters:

• route: This destination's identify route, must be uri string.
• type: Which interface or abstract class this destination for, ignore this if just have single super type.

@Router

This annotation is used to identify which property is used to accept the route.

So, this property must be a class's variable property or constructor parameter.

The router is passed into this field when the destination object is constructed.

Release

0.2.3

• fixed increase compiler error

0.2.1

• upgrade to kotlin 1.9.22

Maybe you need add this code in your module:

tasks.withType<ProcessResources>{
    duplicatesStrategy = DuplicatesStrategy.INCLUDE
}

0.1.6

• Supported multi router parameter in Destination
• Supported kotlin increase compiler

0.1.5

Firstly version.

License

Copyright 2023 ZhangKe Contributors

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.