Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeziellago/linkt
A lightweight and simple Kotlin library for deep link handling on Android 🔗.
https://github.com/jeziellago/linkt
android deeplink deeplink-library kotlin uri url
Last synced: 5 days ago
JSON representation
A lightweight and simple Kotlin library for deep link handling on Android 🔗.
- Host: GitHub
- URL: https://github.com/jeziellago/linkt
- Owner: jeziellago
- License: mit
- Created: 2021-02-02T02:07:43.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-17T11:40:06.000Z (over 3 years ago)
- Last Synced: 2023-11-07T19:15:10.962Z (12 months ago)
- Topics: android, deeplink, deeplink-library, kotlin, uri, url
- Language: Kotlin
- Homepage:
- Size: 142 KB
- Stars: 101
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Linkt  [](https://androidweekly.net/issues/issue-453)
A lightweight and simple kotlin library for deep link handling on Android.
## Setup
Configure root `build.gradle` (jitpack.io):
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
Add `Linkt` to your project `build.gradle`:
```
dependencies {
implementation 'com.github.jeziellago:Linkt:TAG'
}
```
1. Create your `DeepLinkModule` and register deep links:
```kotlin
class MyDeepLinkModule : DeepLinkModule {
override fun load() {
deepLinkOf(
"linkt://sample",
"linkt://sample/{userId}/{userName}"
) { context, bundle ->
Intent(context, MainActivity::class.java)
.apply { putExtras(bundle) }
}
}
}
```
> In multi-module projects you should have one or more DeepLinkModule`s.
>
2. Register your modules into `Application#onCreate`, with `DeepLinkLoader#setup`:
```kotlin
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
DeepLinkLoader.setup(MyDeepLinkModule())
}
}
```
3. Create the `DeepLinkActivity` (or use yours if already exists), and call `DeepLinkLoader#loadFrom`:
```kotlin
class DeepLinkActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// resolve deeplink
DeepLinkLoader.loadFrom(this)
}
}
```
Don't forget to configure `AndroidManifest.xml` (required for Android deep links):
```xml
```
## How to get data from deeplink?
In your activity, you can get path parameters and query values as `String` from `intent.extras`:
### Path parameters
- Template `linkt://sample/{userId}/{userName}`
- Received: `linkt://sample/9999/Jose`
```kotlin
// get path parameters
val userId = intent.extras.getString("userId")
val userId = intent.extras.getString("userName")
```
### Query parameters
- Template: `linkt://sample`
- Received `linkt://sample?subject=Linkt&name=Sample`
```kotlin
// get query parameters
val subject = intent.extras.getString("subject")
val name = intent.extras.getString("name")
```
### Path + query parameters
- Template `linkt://sample/{userId}/{userName}`
- Received `linkt://sample/999/Jose?subject=Linkt&name=Sample`
```kotlin
// get path parameters
val userId = intent.extras.getString("userId")
val userId = intent.extras.getString("userName")
// get query parameters
val subject = intent.extras.getString("subject")
val name = intent.extras.getString("name")
```
## Licence
```
Copyright (c) 2021 Jeziel Lago
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```