Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denisidoro/krouter
A lightweight Android activity router
https://github.com/denisidoro/krouter
Last synced: 3 months ago
JSON representation
A lightweight Android activity router
- Host: GitHub
- URL: https://github.com/denisidoro/krouter
- Owner: denisidoro
- License: mit
- Created: 2016-09-18T00:55:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-24T02:51:58.000Z (about 6 years ago)
- Last Synced: 2024-01-20T19:34:50.375Z (5 months ago)
- Language: Kotlin
- Size: 68.4 KB
- Stars: 122
- Watchers: 4
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-list - denisidoro/krouter - A lightweight Android activity router (Kotlin)
- awesome-kotlin - denisidoro/krouter - A lightweight Android activity router. (<a name="android"></a>Android <sup>[Back ⇈](#android-category)</sup> / <a name="android-libraries"></a>Libraries <sup>[Back ⇈](#android-libraries-subcategory)</sup>)
- awesome-kotlin-libraries-for-android - Krouter - A lightweight Android activity router. (<a name="utility"></a>Utility <sup>[Back ⇈](#contents)</sup>)
README
# Krouter
A lightweight Android activity router written in Kotlin.
### Basic usage
```kotlin
// anywhere in the app, preferably on application creation
val krouter = Krouter.from(context, hashMapOf(
"user/:id/likes" to UserLikesActivity::class.java
))
// anywhere that can access the val above
krouter.start("user/42/likes") // this will start UserLikesActivity
// inside UserLikesActivity, possibly inside onCreate()
val id: Int = intent.getIntExtra("id", 0) // 42
```
### Adding more extras
In order to add more extras to the intent, one can do the following:
```kotlin
krouter.getRouter("user/42/likes")!!
.withIntent { it.putExtra("name", "John") }
.start()
```
### Starting for result
In order to set a request code:
```kotlin
krouter.getRouter("user/42/likes")!!
.startForResult(activity, 123) // 123 is the request code
```
### Advanced routing configuration
It is possible to instantiate Krouter establishing a regular expression that the parameter must specify:
```kotlin
val krouter = Krouter(context, hashMapOf(
Route("user/:id/likes", hashMapOf(
"id" to Schema("^[0-9]{2}$")
)) to UserLikesActivity::class.java
)
```
There are default implementations for integer, float, double, long, char:
```kotlin
// the constants must be statically imported from Schema.Type
Route("user/:id/likes", hashMapOf("id" to Schema(INT)))
Route("my/balance/:value", hashMapOf("value" to Schema(FLOAT)))
```
If no schema is defined, Krouter will try to infer the type accordingly.
If no schema is suitable, the param will be coerced to a String.
### Interceptor
You can add some interceptors to Krouter:
```Kotlin
// If you are not logged in, go to login
krouter.addInterceptor(object : Interceptor {
override fun intercept(chain: Interceptor.Chain): Router? {
val route = chain.request()
if(route?.url == "user/:id" && !login) {
val target = chain.proceed(route)
val router = krouter.getRouter("login")
router?.intent?.putExtra("nav", target?.url)
router?.update()
return router
}
return chain.proceed(route)
}
})
```
### Installation
Add the dependency:
```gradle
dependencies {
compile 'com.github.denisidoro.github:krouter:0.0.2'
}
```
### Best practices
- **Use dependency injection**: Krouter was idealized to be used in conjunction with Dagger.
- **Compose routers**: say you have an activity flow in your app that's only accessible to users who are admin, for instance. If you don't want to deal with a huge routing map that has routes *all* flows, then create multiple Krouter instances. `val globalKrouter` and `@AdminScope val adminKrouter`, for example.