android-components / mozilla.components.browser.state.state / CustomTabConfig


data class CustomTabConfig (source)

Holds configuration data for a Custom Tab.


Name Summary
<init> CustomTabConfig(id: String = UUID.randomUUID().toString(), toolbarColor: Int? = null, closeButtonIcon: <ERROR CLASS>? = null, enableUrlbarHiding: Boolean = false, actionButtonConfig: CustomTabActionButtonConfig? = null, showCloseButton: Boolean = true, showShareMenuItem: Boolean = false, menuItems: List<CustomTabMenuItem> = emptyList(), exitAnimations: <ERROR CLASS>? = null, navigationBarColor: Int? = null, titleVisible: Boolean = false, sessionToken: CustomTabsSessionToken? = null, externalAppType: ExternalAppType = ExternalAppType.CUSTOM_TAB)
Holds configuration data for a Custom Tab.


Name Summary
actionButtonConfig val actionButtonConfig: CustomTabActionButtonConfig?
Custom action button on the toolbar.
closeButtonIcon val closeButtonIcon: <ERROR CLASS>?
Custom icon of the back button on the toolbar.
enableUrlbarHiding val enableUrlbarHiding: Boolean
Enables the toolbar to hide as the user scrolls down on the page.
exitAnimations val exitAnimations: <ERROR CLASS>?
Bundle containing custom exit animations for the tab.
externalAppType val externalAppType: ExternalAppType
How this custom tab is being displayed.
id val id: String
a unique ID of this custom tab.
menuItems val menuItems: List<CustomTabMenuItem>
Custom overflow menu items.
navigationBarColor val navigationBarColor: Int?
Background color for the navigation bar.
sessionToken val sessionToken: CustomTabsSessionToken?
The token associated with the custom tab.
showCloseButton val showCloseButton: Boolean
Specifies whether the close button will be shown on the toolbar.
showShareMenuItem val showShareMenuItem: Boolean
Specifies whether a default share button will be shown in the menu.
titleVisible val titleVisible: Boolean
Whether the title should be shown in the custom tab.
toolbarColor val toolbarColor: Int?
Background color for the toolbar.

Extension Functions

Name Summary
loadResourceAsString fun Any.loadResourceAsString(path: String): String
Loads a file from the resources folder and returns its content as a string object.