browser-ktx/io.github.edricchan03.androidx.browser.ktx

Package-level declarations

Top-level Kotlin extensions for AndroidX Browser.

Properties

activityResizeBehavior

@set:ExperimentalBrowserApi

var Intent.activityResizeBehavior: ActivityHeightResizeBehavior

The Custom Tab Activity's resize behavior.

activitySideSheetBreakpointDp

@get:Dimension(unit = 0)

@set:ExperimentalBrowserApi

var Intent.activitySideSheetBreakpointDp: Int

Extra that, if set, allows you to set a custom breakpoint for the Custom Tab - a value, x, for which if the screen's width is higher than x, the Custom Tab will behave as a side sheet (if CustomTabsIntent.EXTRA_INITIAL_ACTIVITY_WIDTH_PX is set), otherwise it will behave as a bottom sheet (if CustomTabsIntent.EXTRA_INITIAL_ACTIVITY_HEIGHT_PX is set).

activitySideSheetDecorationType

@set:ExperimentalBrowserApi

var Intent.activitySideSheetDecorationType: ActivitySideSheetDecorationType

Extra that, if set, allows you to set how you want to distinguish the Partial Custom Tab side sheet from the rest of the display.

activitySideSheetEnableMaximization

@set:ExperimentalBrowserApi

var Intent.activitySideSheetEnableMaximization: Boolean

Extra that enables the maximization button on the side sheet Custom Tab toolbar.

activitySideSheetPosition

@set:ExperimentalBrowserApi

var Intent.activitySideSheetPosition: ActivitySideSheetPosition

Extra that specifies the position of the side sheet. By default it is set to ActivitySideSheetPosition.End, which is on the right side in left-to-right layout.

activitySideSheetRoundedCornersPosition

@set:ExperimentalBrowserApi

var Intent.activitySideSheetRoundedCornersPosition: ActivitySideSheetRoundedCornersPosition

Extra that, if set, allows you to choose which side sheet corners should be rounded, if any at all. Options include top or none.

closeButtonIcon

@ExperimentalBrowserApi

var Intent.closeButtonIcon: Bitmap?

Specifies the icon bitmap of the back button on the toolbar.

closeButtonPosition

@set:ExperimentalBrowserApi

var Intent.closeButtonPosition: CloseButtonPosition

The position of the close button as a CloseButtonPosition, or the default position if the extra is not set.

colorScheme

@ExperimentalBrowserApi

var Intent.colorScheme: ColorScheme

Specifies which color scheme should be applied to the custom tab.

initialActivityHeightPx

@get:Dimension(unit = 1)

@set:ExperimentalBrowserApi

var Intent.initialActivityHeightPx: Int

The Custom Tab Activity's initial height, or 0 if it is not set.

initialActivityWidthPx

@get:Dimension(unit = 1)

@set:ExperimentalBrowserApi

var Intent.initialActivityWidthPx: Int

Extra that, if set, makes the Custom Tab Activity's width to be x pixels, the Custom Tab will behave as a side sheet. A minimum width will be enforced, thus the width will be clamped as such (based on the window size classes as defined by the Android documentation):

instantAppsEnabled

@ExperimentalBrowserApi

var Intent.instantAppsEnabled: Boolean

Whether Instant Apps is enabled for this intent.

isBackgroundInteractionEnabled

@set:ExperimentalBrowserApi

var Intent.isBackgroundInteractionEnabled: Boolean

Whether the background interaction is enabled.

isBookmarksButtonEnabled

@set:ExperimentalBrowserApi

var Intent.isBookmarksButtonEnabled: Boolean

Whether the bookmarks button is enabled. This value is set to true by default.

isDownloadButtonEnabled

@set:ExperimentalBrowserApi

var Intent.isDownloadButtonEnabled: Boolean

Whether the download button is enabled. This value is set to true by default.

isSendToExternalDefaultHandlerEnabled

@set:ExperimentalBrowserApi

var Intent.isSendToExternalDefaultHandlerEnabled: Boolean

Whether initial URLs are to be sent to external handler apps.

secondaryToolbarSwipeUpGesture

@set:ExperimentalBrowserApi

var Intent.secondaryToolbarSwipeUpGesture: PendingIntent?

The PendingIntent that will be sent when the user swipes up from the secondary toolbar.

shareState

@ExperimentalBrowserApi

var Intent.shareState: ShareState

The ShareState of this intent, or the default share state if the extra is not set.

shouldAlwaysUseBrowserUI

@set:ExperimentalBrowserApi

var Intent.shouldAlwaysUseBrowserUI: Boolean

Whether a browser receiving the given intent should always use browser UI and avoid using any custom tabs UI.

showTitle

@ExperimentalBrowserApi

var Intent.showTitle: Boolean

Whether the title should be shown in the custom tab.

toolbarCornerRadiusDp

@get:Dimension(unit = 0)

@set:ExperimentalBrowserApi

var Intent.toolbarCornerRadiusDp: Int

The toolbar's top corner radii in dp.

translateLocale

@set:ExperimentalBrowserApi

var Intent.translateLocale: Locale?

Gets the target locale for the Translate UI.

urlBarHidingEnabled

@ExperimentalBrowserApi

var Intent.urlBarHidingEnabled: Boolean

Specifies whether the URL bar should be hidden as the user scrolls down the page.

Functions

colorSchemeParams

inline fun colorSchemeParams(init: CustomTabColorSchemeParams.Builder.() -> Unit): CustomTabColorSchemeParams

Creates a CustomTabColorSchemeParams using DSL syntax.

fun colorSchemeParams(@ColorInt toolbarColor: Int? = null, @ColorInt secondaryToolbarColor: Int? = null, @ColorInt navigationBarColor: Int? = null, @ColorInt navigationBarDividerColor: Int? = null): CustomTabColorSchemeParams

Creates a CustomTabColorSchemeParams using the given colour integers.

customTabsIntent

inline fun customTabsIntent(session: CustomTabsSession? = null, init: CustomTabsIntent.Builder.() -> Unit): CustomTabsIntent

Creates a Custom Tab Intent using DSL syntax. Optionally, an existing session may be specified.

customTabsIntentBuilder

fun customTabsIntentBuilder(session: CustomTabsSession? = null): CustomTabsIntent.Builder

Creates a CustomTabsIntent.Builder. Optionally, an existing session may be specified.

getColorSchemeParams

fun Intent.getColorSchemeParams(colorScheme: ColorScheme): CustomTabColorSchemeParams

Retrieves the instance of androidx.browser.customtabs.CustomTabColorSchemeParams from an Intent for a given colour scheme. Uses values passed directly into CustomTabsIntent.Builder (e.g. via CustomTabsIntent.Builder.setToolbarColor) as defaults.

setActivitySideSheetDecorationType

fun CustomTabsIntent.Builder.setActivitySideSheetDecorationType(type: ActivitySideSheetDecorationType): CustomTabsIntent.Builder

Sets the Custom Tab Activity's decoration type that will be displayed when it is acting as a side sheet.

setActivitySideSheetPosition

fun CustomTabsIntent.Builder.setActivitySideSheetPosition(position: ActivitySideSheetPosition): CustomTabsIntent.Builder

Sets the Custom Tab Activity's position when acting as a side sheet.

setActivitySideSheetRoundedCornersPosition

fun CustomTabsIntent.Builder.setActivitySideSheetRoundedCornersPosition(position: ActivitySideSheetRoundedCornersPosition): CustomTabsIntent.Builder

Sets the Custom Tab Activity's rounded corners position when it is acting as a side sheet.

setAlwaysUseBrowserUI

fun Intent.setAlwaysUseBrowserUI(): Intent

Adds the necessary flags and extras to signal any browser supporting custom tabs to use the browser UI at all times and avoid showing custom tab like UI.

setCloseButtonPosition

fun CustomTabsIntent.Builder.setCloseButtonPosition(position: CloseButtonPosition): CustomTabsIntent.Builder

Sets the position of the close button. This method allows for an enum CloseButtonPosition to be used.

setColorScheme

fun CustomTabsIntent.Builder.setColorScheme(scheme: ColorScheme): CustomTabsIntent.Builder

Sets the colour scheme that should be applied to the user interface in the custom tab. This method allows for an enum ColorScheme to be used.

setColorSchemeParams

fun CustomTabsIntent.Builder.setColorSchemeParams(scheme: ColorScheme, params: CustomTabColorSchemeParams): CustomTabsIntent.Builder

fun CustomTabsIntent.Builder.setColorSchemeParams(scheme: ColorScheme, paramsInit: CustomTabColorSchemeParams.Builder.() -> Unit): CustomTabsIntent.Builder

fun CustomTabsIntent.Builder.setColorSchemeParams(scheme: ColorScheme, @ColorInt toolbarColor: Int? = null, @ColorInt secondaryToolbarColor: Int? = null, @ColorInt navigationBarColor: Int? = null, @ColorInt navigationBarDividerColor: Int? = null): CustomTabsIntent.Builder

Sets CustomTabColorSchemeParams for the given colour scheme.

setDefaultColorSchemeParams

inline fun CustomTabsIntent.Builder.setDefaultColorSchemeParams(init: CustomTabColorSchemeParams.Builder.() -> Unit): CustomTabsIntent.Builder

Sets the default colour scheme to use using DSL syntax.

fun CustomTabsIntent.Builder.setDefaultColorSchemeParams(@ColorInt toolbarColor: Int? = null, @ColorInt secondaryToolbarColor: Int? = null, @ColorInt navigationBarColor: Int? = null, @ColorInt navigationBarDividerColor: Int? = null): CustomTabsIntent.Builder

Sets the default colour scheme to use.

setInitialActivityHeightPx

fun CustomTabsIntent.Builder.setInitialActivityHeightPx(@Dimension(unit = 1) initialHeightPx: Int, activityHeightResizeBehavior: ActivityHeightResizeBehavior): CustomTabsIntent.Builder

Sets the Custom Tab Activity's initial height in pixels and the desired resize behavior. The Custom Tab will behave as a bottom sheet.

setInitialActivitySizePx

fun CustomTabsIntent.Builder.setInitialActivitySizePx(size: Size, activityHeightResizeBehavior: ActivityHeightResizeBehavior = ActivityHeightResizeBehavior.Default): CustomTabsIntent.Builder

fun CustomTabsIntent.Builder.setInitialActivitySizePx(@Dimension(unit = 1) sizePx: Pair<Int, Int>, activityHeightResizeBehavior: ActivityHeightResizeBehavior = ActivityHeightResizeBehavior.Default): CustomTabsIntent.Builder

fun CustomTabsIntent.Builder.setInitialActivitySizePx(@Dimension(unit = 1) widthPx: Int, @Dimension(unit = 1) heightPx: Int, activityHeightResizeBehavior: ActivityHeightResizeBehavior = ActivityHeightResizeBehavior.Default): CustomTabsIntent.Builder

Sets the Custom Tab Activity's initial width/height in pixels. The Custom Tab will behave as a side sheet if the screen's width is bigger than the breakpoint value set by CustomTabsIntent.Builder.setActivitySideSheetBreakpointDp and the screen is big enough, see doc for CustomTabsIntent.EXTRA_INITIAL_ACTIVITY_WIDTH_PX.

setShareState

fun CustomTabsIntent.Builder.setShareState(state: ShareState): CustomTabsIntent.Builder

Sets the share state that should be applied to the custom tab. This method allows for an enum ShareState to be used.