https://github.com/droibit/customtabslauncher
Library to help the launch of Custom Tabs.
https://github.com/droibit/customtabslauncher
android-library chrome-custom-tabs chrome-customtabs kotlin-android
Last synced: 3 months ago
JSON representation
Library to help the launch of Custom Tabs.
- Host: GitHub
- URL: https://github.com/droibit/customtabslauncher
- Owner: droibit
- License: apache-2.0
- Created: 2016-04-26T13:44:41.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2026-02-22T08:37:00.000Z (5 months ago)
- Last Synced: 2026-02-22T13:43:42.033Z (5 months ago)
- Topics: android-library, chrome-custom-tabs, chrome-customtabs, kotlin-android
- Language: Kotlin
- Homepage:
- Size: 347 KB
- Stars: 8
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CustomTabsLauncher
[](https://github.com/droibit/CustomTabsLauncher/actions/workflows/android.yml)
[](https://central.sonatype.com/artifact/io.github.droibit/customtabslauncher/4.1.0)
[](https://github.com/droibit/prefbinding/blob/develop/LICENSE)
This library makes it easy to
launch [Custom Tabs](https://developer.chrome.com/docs/android/custom-tabs) directly from your app.
In some user environments, Custom Tabs may not launch directly. This can happen in the following
cases:
- Multiple browser apps are installed on the device.
- The default browser is not Chrome.
Custom Tabs can be displayed as a screen within your app, allowing you to customize the look and feel.
For this reason, I created this library to make it easier to launch Chrome Custom Tabs directly.
## Download
Add the following dependency to your `build.gradle` file:
```kotlin
implementation("io.github.droibit:customtabslauncher:LATEST_VERSION")
// Recommended: Declare androidx.browser explicitly as a dependency.
// implementation 'androidx.browser:browser:LATEST_VERSION'
```
## Usage
### Basic Usage
#### Launch with Chrome Custom Tabs
```kotlin
try {
val customTabsIntent = buildCustomTabsIntent()
.setChromeCustomTabsPackage(context)
customTabsIntent.launchUrl(context, Uri.parse("https://example.com"))
} catch (e: ActivityNotFoundException) {
// Launch WebView, display a toast, etc.
}
```
#### Launch with the default browser that supports Custom Tabs
```kotlin
try {
val customTabsIntent = buildCustomTabsIntent()
.setCustomTabsPackage(context)
customTabsIntent.launchUrl(context, Uri.parse("https://example.com"))
} catch (e: ActivityNotFoundException) {
// Launch WebView, display a toast, etc.
}
```
### Present a Custom Tab as a bottom sheet
```kotlin
val activityLauncher = registerForActivityResult(StartActivityForResult()) {
// Do something.
}
try {
val customTabsIntent = buildCustomTabsIntent().apply {
setChromeCustomTabsPackage(context) // or setCustomTabsPackage(context)
intent.data = Uri.parse("https://example.com")
}
activityLauncher.launch(customTabsIntent.intent)
} catch (e: ActivityNotFoundException) {
// Launch WebView, display a toast, etc.
}
```
### Fallback to a non-Chrome browser
```kotlin
buildCustomTabsIntent()
.setChromeCustomTabsPackage( // or .setCustomTabsPackage(
context,
// Launch a browser that supports Custom Tabs (non-Chrome).
NonChromeCustomTabs(context)
// or launch a specific browser that supports Custom Tabs.
// NonChromeCustomTabs(
// listOf("org.mozilla.firefox", "com.microsoft.emmx")
// )
)
```
### Authentication using the Auth Tab
```kotlin
val launcher = AuthTabIntent.registerActivityResultLauncher(context) { result ->
// Handle the result of the Auth Tab.
}
val authTabIntent = buildAuthTabIntent()
.setChromeCustomTabsPackage(context)
authTabIntent.launch(launcher, AUTHENTICATION_URL, REDIRECT_SCHEME)
```
## License
Copyright (C) 2015 The Android Open Source Project
Copyright (C) 2016 Shinya Kumagai
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.