platform_frontend_api_common_uicontrols/com.tomtom.ivi.platform.frontend.api.common.uicontrols.navigation

Package-level declarations

Contains classes for building navigable panels.

Types

Link copied to clipboard
@IviExperimental(reasons = [])
class Breadcrumb(val label: StringResolver, val icon: DrawableResolver? = null, val onClicked: () -> Unit = {})

Represents a breadcrumb. Part of NavigationBarViewModel, so that the navigation bar can show a breadcrumb for each panel that the end-user can navigate to.

Link copied to clipboard
interface NavigablePanelViewModel<P : NavigablePanel<*>> : PanelProvider<P>

An interface for view models which provides panel navigation data.

Link copied to clipboard
@IviExperimental(reasons = [])
data class NavigationBarViewModel(val showBackButton: Boolean = false, val onBackButtonClicked: () -> Unit = {}, val title: StringResolver? = null, val breadcrumbs: List<Breadcrumb> = emptyList())

View model for a navigation bar, such as TtNavigationBar. The navigation bar allows the end-user to navigate between different panels.

Inherited functions

Link copied to clipboard
@IviExperimental(reasons = [])
fun TtNavigationBar.setViewModel(viewModel: NavigationBarViewModel?)

Adapter to set a NavigationBarViewModel for a TtNavigationBar.

Link copied to clipboard
@IviExperimental(reasons = [])
fun LiveData<NavigationBarViewModel?>.withBackButton(): LiveData<NavigationBarViewModel?>

Converts LiveData of NavigationBarViewModel to the same type and content, except that NavigationBarViewModel.showBackButton is set to true.

Link copied to clipboard
Link copied to clipboard
@IviExperimental(reasons = [])
fun LiveData<NavigationBarViewModel?>.withoutBreadcrumbs(): LiveData<NavigationBarViewModel?>

Converts LiveData of NavigationBarViewModel to the same type and content, except that NavigationBarViewModel.breadcrumbs is set to an empty list.

Link copied to clipboard
@IviExperimental(reasons = [])
fun LiveData<NavigationBarViewModel?>.withoutTitle(): LiveData<NavigationBarViewModel?>

Converts LiveData of NavigationBarViewModel to the same type and content, except that NavigationBarViewModel.title is set to null.