maplibre-compose-material3/dev.sargunv.maplibrecompose.material3.controls

Package-level declarations

Material 3 based controls for the map as an alternative to the default map ornaments.

Types

ScaleBarMeasure

interface ScaleBarMeasure

A measure to show in the scale bar

ScaleBarMeasures

data class ScaleBarMeasures(val primary: ScaleBarMeasure, val secondary: ScaleBarMeasure? = null)

Which measures to show on the scale bar.

Functions

AttributionButton

@Composable

fun AttributionButton(styleState: StyleState, modifier: Modifier = Modifier, colors: IconButtonColors = IconButtonDefaults.iconButtonColors())

CompassButton

@Composable

fun CompassButton(cameraState: CameraState, modifier: Modifier = Modifier, onClick: () -> Unit = {}, colors: ButtonColors = ButtonDefaults.elevatedButtonColors(), contentDescription: String = "Compass")

DisappearingCompassButton

@Composable

fun DisappearingCompassButton(cameraState: CameraState, modifier: Modifier = Modifier, onClick: () -> Unit = {}, colors: ButtonColors = ButtonDefaults.elevatedButtonColors(), visibilityDuration: Duration = 1.seconds, enterTransition: EnterTransition = fadeIn(), exitTransition: ExitTransition = fadeOut())

DisappearingScaleBar

@Composable

fun DisappearingScaleBar(metersPerDp: Double, zoom: Double, modifier: Modifier = Modifier, measures: ScaleBarMeasures = defaultScaleBarMeasures(), haloColor: Color = MaterialTheme.colorScheme.surface, color: Color = contentColorFor(haloColor), textStyle: TextStyle = MaterialTheme.typography.labelMedium, alignment: Alignment.Horizontal = Alignment.Start, visibilityDuration: Duration = 3.seconds, enterTransition: EnterTransition = fadeIn(), exitTransition: ExitTransition = fadeOut())

An animated scale bar that appears when the zoom level of the map changes, and then disappears after visibilityDuration. This composable wraps ScaleBar with visibility animations.

ScaleBar

@Composable

fun ScaleBar(metersPerDp: Double, modifier: Modifier = Modifier, measures: ScaleBarMeasures = defaultScaleBarMeasures(), haloColor: Color = MaterialTheme.colorScheme.surface, color: Color = contentColorFor(haloColor), textStyle: TextStyle = MaterialTheme.typography.labelSmall, alignment: Alignment.Horizontal = Alignment.Start)

A scale bar composable that shows the current scale of the map in feet, meters or feet and meters when zoomed in to the map, changing to miles and kilometers, respectively, when zooming out.