navigation-ux-map-gpt/com.mapbox.navigation.mapgpt/MapGptCompose

MapGptCompose

class MapGptCompose

Constructors

constructor()

Default constructor is used in the Compose Preview. You should get the instance through the Dash.mapGptCompose property.

Properties

val avatar: StateFlow<MapGptAvatar>

Surfaces the current avatar used to show the conversation states.

chatBubbleState

val chatBubbleState: StateFlow<ChatBubbleState>

Surfaces the conversation state used to show the chat bubble.

val chatItems: StateFlow<List<ChatItem>>

Surfaces the current items used to show the conversation and action items.

val config: MutableStateFlow<MapGptComposeConfig>

val isAvailable: StateFlow<Boolean>

Surfaces if the MapGpt feature is available.

val isEnabled: StateFlow<Boolean>

val sessionError: StateFlow<Throwable?>

Surfaces a session error when there is one available. If there is no error, the value is null.

val sessionState: StateFlow<SessionState>

Surfaces the current MapGPT connection state.

Functions

fun attachContent(composeView: ComposeView, content: @Composable () -> Unit): MapGptDetachableUI

Apply the Mapbox styles to the provided ComposeView. This is often needed to use the Mapbox Compose components.

fun Avatar(modifier: Modifier = Modifier, onClick: () -> Unit = {}, mapGptAvatar: MapGptAvatar? = null)

fun ChatBubbleView(modifier: Modifier = Modifier)

fun ChatCarousel(modifier: Modifier = Modifier)

Default UI for the MapGPT carousel. This includes the chat bubble and clickable cards.

fun Connection()

When building your own MapGPT UI, you should use this composable to connect the MapGPT state to your UI. This is also called in the default UI and is not required.

KeyboardModeButton

fun KeyboardModeButton(modifier: Modifier, onClick: () -> Unit)

Default UI used for opening the keyboard mode.

KeyboardModeExpanded

fun KeyboardModeExpanded(modifier: Modifier, onCloseClick: () -> Unit)

Default UI for the MapGPT chat with the keyboard feature.

onActivationClicked

fun onActivationClicked()

Function to handle activating the voice assistant.

fun onCardClicked(item: ChatItem.Card)

Function to handle the user selecting a card from the keyboard mode.

suspend fun onSendClicked(message: String)

Function to send a message through the keyboard mode.

fun PreviewTheme(content: @Composable () -> Unit)

Function that can be used to preview components.