navigation-ux-destination-preview/com.mapbox.dash.destination.preview.presentation

Package-level declarations

Types

Action

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface Action

ActionButtonState

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class ActionButtonState(val action: Action, val countDown: Boolean)

ChargeRouteHelper

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class ChargeRouteHelper(appStore: AppStore, observeEvData: ObserveEvData, routeTrimmer: RouteTrimmer, observeMinChargePoint: ObserveMinChargePoint)

DestinationPreviewContentBuilder

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class DestinationPreviewContentBuilder(destinationViewModel: DestinationViewModel, observeFavorites: ObserveFavoritesUseCase, ratingConfig: RatingConfig, dashEvRefreshLocationProvider: DashEvRefreshLocationProvider, formatter: DistanceAndTimeFormatter, locale: Locale, getNearbyDestinationsGroups: GetNearbyDestinationsGroupsUseCase, resources: Resources)

DestinationPreviewLayout

class DestinationPreviewLayout : Layout<DestinationPreviewLayout>

Represents a layout for previewing destination information with customizable blocks.

DestinationPreviewViewState

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class DestinationPreviewViewState(val visible: State<Boolean> = mutableStateOf(false), val skipDestinationPreview: State<Boolean> = mutableStateOf(false), val destinationState: State<DestinationState> = mutableStateOf(DestinationState.WaitingData), val leftButtonState: State<ActionButtonState?> = mutableStateOf(value = null), val rightButtonState: State<ActionButtonState?> = mutableStateOf(value = null), val alreadyOnTheRoute: State<Boolean> = mutableStateOf(value = false), val focusedElement: State<FocusedElement?> = mutableStateOf(value = null), val titleSingleLine: State<Boolean> = mutableStateOf(value = false), val collapseBottomSheetEvent: Flow<Unit> = emptyFlow(), val destinationResult: State<DestinationResult?> = mutableStateOf(null), val previewLayout: State<DestinationPreviewLayout?> = mutableStateOf(null), val onClickLeftButton: () -> Unit = {}, val onClickRightButton: () -> Unit = {}, val onClickFavorite: (DestinationSearchResult, String) -> Unit = { _, _ -> }, val onClickFeedback: () -> Unit = {}, val onDestinationGroupClick: (String, NearbyDestinationsGroup) -> Unit = { _, _ -> }, val onRoutePreviewRetryClick: () -> Unit = {})

DestinationResult

class DestinationResult

Represents detailed information about a destination, including various attributes like arrival information, charge time, weather conditions, ratings, and more.

DestinationViewModel

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class DestinationViewModel(appStore: AppStore, backToSearchResults: BackToSearchResultsUseCase, observeDestinationState: ObserveDestinationStateUseCase, observePreviewVisibility: ObserveDestinationPreviewVisibilityUseCase, observeParkingBreakEnabled: ObserveParkingBreakEnabledUseCase, observeShowRoutePreview: ObserveShowRoutePreviewUseCase, updateNavigationRoutes: UpdateNavigationRoutesUseCase, analytics: DestinationPreviewAnalytics, previewRoute: PreviewRouteToPreviewResultUseCase, addWaypoint: AddWaypointUseCase, removeWaypoint: RemoveSelectedWaypointUseCase, cancelRoutePreview: StopPreviewNavigationUseCase, navigate: NavigateUseCase, favoriteAnalytics: FavoriteAnalytics, searchAnalytics: SearchAnalytics, observeMapMoving: ObserveMapMovingUseCase, openFeedback: OpenFeedbackUseCase, configRepository: ConfigRepository, placeWeatherFormatter: PlaceWeatherFormatter, placeWeatherIconProvider: PlaceWeatherIconProvider, batteryCapacity: Flow<Int?>, dashEvLocationProvider: DashEvLocationProvider, chargeRouteHelper: ChargeRouteHelper, searchStore: SearchStore, routeTrimmer: RouteTrimmer, observeMinChargePoint: ObserveMinChargePoint, fetchRoundTripSocUseCase: FetchRoundTripSocUseCase) : ViewModel

EvFilterButtonVisibilityUseCase

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class EvFilterButtonVisibilityUseCase(appStore: AppStore, isEvSearchFilterVisible: IsEvSearchFilterVisible)

FiltersViewModel

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class FiltersViewModel(evFilterButtonVisibility: EvFilterButtonVisibilityUseCase, observeMapMoving: ObserveMapMovingUseCase, closeBackButtonHandler: CloseBackButtonHandler, settingsRepository: SettingsRepository, repeatLastSearch: RepeatLastSearchUseCase) : ViewModel

FiltersViewState

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class FiltersViewState(val visible: State<Boolean> = mutableStateOf(false), val available: State<Boolean> = mutableStateOf(false), val openNow: State<Boolean> = mutableStateOf(false), val plugCharge: State<Boolean> = mutableStateOf(false), val collapseBottomSheetEvent: Flow<Unit> = emptyFlow(), val onAvailableChange: (enabled: Boolean) -> Unit = {}, val onOpenNowChange: (enabled: Boolean) -> Unit = {}, val onPlugChargeChange: (enabled: Boolean) -> Unit = {}, val onClickApply: () -> Unit = {})

FocusedElement

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

sealed class FocusedElement

FocusNavigationHelper

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface FocusNavigationHelper

PlaceWeatherFormatter

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface PlaceWeatherFormatter

PlaceWeatherIconProvider

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface PlaceWeatherIconProvider

PrimaryAction

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

enum PrimaryAction : Enum<PrimaryAction> , Action

RoutesOverviewState

class RoutesOverviewState

RoutesOverviewUiComposer

typealias RoutesOverviewUiComposer = @Composable (Modifier, RoutesOverviewState, BackCloseButtonState?) -> Unit

RoutesOverviewViewModel

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class RoutesOverviewViewModel(appStore: AppStore, val mapMoving: ObserveMapMovingUseCase, observeRouteProgressUseCase: ObserveRouteProgressUseCase) : ViewModel, FocusNavigationHelper

SecondaryAction

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

enum SecondaryAction : Enum<SecondaryAction> , Action

TripOverviewViewModel

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class TripOverviewViewModel(updateNavigationRoutes: UpdateNavigationRoutesUseCase, backToSearchResults: BackToSearchResultsUseCase, navigate: NavigateUseCase, val mapMoving: ObserveMapMovingUseCase, appStore: AppStore, chargeRouteHelper: ChargeRouteHelper, previewRoute: PreviewRouteUseCase) : ViewModel, FocusNavigationHelper

Properties

LocalDestinationPreview

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val LocalDestinationPreview: ProvidableCompositionLocal<DestinationPreviewUiComposer>

LocalRoutesOverview

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val LocalRoutesOverview: ProvidableCompositionLocal<RoutesOverviewUiComposer>

Functions

DefaultDestinationPreview

@Composable

fun DefaultDestinationPreview(modifier: Modifier)

DefaultRoutesOverview

@Composable

fun DefaultRoutesOverview(modifier: Modifier, state: RoutesOverviewState)

DestinationPreview

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Composable

fun DestinationPreview(state: DestinationPreviewViewState, modifier: Modifier = Modifier)

FiltersView

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Composable

fun FiltersView(state: FiltersViewState, modifier: Modifier = Modifier)

rememberDestinationPreviewViewState

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Composable

fun rememberDestinationPreviewViewState(destinationViewModel: DestinationViewModel, placesPreviewViewModel: PlacesPreviewViewModel, observeFavoritesUseCase: ObserveFavoritesUseCase, favoritePlaceViewModel: FavoritePlaceViewModel, nearbyDestinationsViewModel: NearbyDestinationsViewModel, ratingConfig: RatingConfig, dashEvRefreshLocationProvider: DashEvRefreshLocationProvider, dateTimeFormatter: DistanceAndTimeFormatter, layoutEditor: DashLayoutEditor, locale: Locale, getNearbyDestinationsGroups: GetNearbyDestinationsGroupsUseCase): DestinationPreviewViewState

rememberFiltersViewState

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Composable

fun rememberFiltersViewState(filtersViewModel: FiltersViewModel): FiltersViewState

RoutesOverview

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Composable

fun RoutesOverview(modifier: Modifier = Modifier, viewModel: RoutesOverviewViewModel = koinViewModel())

TripOverview

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Composable

fun TripOverview(modifier: Modifier = Modifier, tripOverviewViewModel: TripOverviewViewModel = koinViewModel())

TripOverviewItems

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

@Composable

fun TripOverviewItems(modifier: Modifier = Modifier, items: List<TripOverviewItem>, onYourLocationClick: () -> Unit? = null, onAddStopClick: () -> Unit? = null, onWaypointClick: (DashSearchResult) -> Unit? = null, onEndOfChargeClick: (List<Point>) -> Unit? = null)