mapbox-maps-android/com.mapbox.maps.extension.compose.gestures

Package-level declarations

Types

GestureScope

@MapboxExperimental

class GestureScope

Receiver scope for registering gesture listeners on a MapboxMap.

GesturesState

@MapboxExperimental

@Stable

class GesturesState(initialGesturesSettings: GesturesSettings = GesturesSettings { })

A state holder for gesture configuration and gesture event observation.

Functions

GestureInput

@MapboxExperimental

@Composable

fun GesturesState.GestureInput(block: suspend GestureScope.() -> Unit)

Runs block with a GestureScope receiver in a coroutine scoped to the map attachment lifecycle. The coroutine is canceled and restarted whenever the map reattaches.

@MapboxExperimental

@Composable

fun GesturesState.GestureInput(key1: Any?, block: suspend GestureScope.() -> Unit)

Runs block with a GestureScope receiver in a coroutine scoped to the map attachment lifecycle. The coroutine is canceled and restarted when key1 or the map changes.

@MapboxExperimental

@Composable

fun GesturesState.GestureInput(vararg keys: Any?, block: suspend GestureScope.() -> Unit)

Runs block with a GestureScope receiver in a coroutine scoped to the map attachment lifecycle. The coroutine is canceled and restarted when any value in keys or the map changes.

@MapboxExperimental

@Composable

fun GesturesState.GestureInput(key1: Any?, key2: Any?, block: suspend GestureScope.() -> Unit)

Runs block with a GestureScope receiver in a coroutine scoped to the map attachment lifecycle. The coroutine is canceled and restarted when key1, key2, or the map changes.

@MapboxExperimental

@Composable

fun GesturesState.GestureInput(key1: Any?, key2: Any?, key3: Any?, block: suspend GestureScope.() -> Unit)

Runs block with a GestureScope receiver in a coroutine scoped to the map attachment lifecycle. The coroutine is canceled and restarted when key1, key2, key3, or the map changes.

rememberGesturesState

@MapboxExperimental

@Composable

inline fun rememberGesturesState(key: String? = null, crossinline init: GesturesState.() -> Unit = {}): GesturesState

Create and remember a GesturesState with init block.