navigation-ux-views-compose/com.mapbox.dash.compose

Package-level declarations

Types

class AndroidViewBlock<Presentation : View, Data : Any>(factory: (Context) -> Presentation, update: suspend (Presentation, Data) -> Unit) : ViewBlock<Data>

A ViewBlock implementation for Android views.

ComposeInsets

@Immutable

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

data class ComposeInsets(val left: Dp = 0.dp, val top: Dp = 0.dp, val right: Dp = 0.dp, val bottom: Dp = 0.dp, drivingSide: LayoutDirection)

When used as paddings, you can either use absolutePadding with left and right insets or drivingSidePadding with start and end insets

ComposeViewBlock

@Stable

class ComposeViewBlock<Data : Any>(block: @Composable (data: Data) -> Unit) : ViewBlock<Data>

A ViewBlock implementation for Compose UI components.

DrivingSideAlignment

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

object DrivingSideAlignment

These alignment options work similar to existing values in Alignment, but they will be mirrored according to the layout direction provided by LocalDrivingSide

DrivingSideArrangement

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

object DrivingSideArrangement

These arrangement options work similar to existing values in Arrangement, but they will be mirrored according to the layout direction provided by LocalDrivingSide

InlineContentFactory

typealias InlineContentFactory = @Composable (InlineContentFactoryParams) -> Map<String, InlineTextContent>

InlineContentFactoryParams

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

data class InlineContentFactoryParams(val textStyle: DashTypography.Style)

Layout

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

interface Layout<L : Layout<L>>

LayoutBuilderCollector

interface LayoutBuilderCollector<T : Layout<T>, Builder : Layout.Builder<T>>

A builder interface for the Layout.

LayoutFlow

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

class LayoutFlow<L : Layout<L>, Builder : Layout.Builder<L>>(val layoutBuilderFactory: () -> Builder, val block: suspend LayoutBuilderCollector<L, Builder>.() -> Unit) : AbstractFlow<L>

ViewBlock

@Stable

abstract class ViewBlock<T> @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor

Abstract base class for all view blocks.

Properties

LocalActiveGuidanceCardWidthId

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

val LocalActiveGuidanceCardWidthId: ProvidableCompositionLocal<Int>

LocalDrivingSide

val LocalDrivingSide: ProvidableCompositionLocal<LayoutDirection>

LocalInsets

val LocalInsets: ProvidableCompositionLocal<Insets>

LocalLeftSidebarWidth

val LocalLeftSidebarWidth: ProvidableCompositionLocal<Dp>

LocalRightSidebarWidth

val LocalRightSidebarWidth: ProvidableCompositionLocal<Dp>

LocalSafeAreaPaddings

val LocalSafeAreaPaddings: ProvidableCompositionLocal<Insets>

LocalShowCloseButtonInCards

val LocalShowCloseButtonInCards: ProvidableCompositionLocal<Boolean>

LocalViewTreeScopeOwner

val LocalViewTreeScopeOwner: ProvidableCompositionLocal<Scope?>

NoOpUpdate

val NoOpUpdate: View.(Any) -> Unit

A no-operation update function for views.

Functions

drivingSidePadding

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

fun Modifier.drivingSidePadding(start: Dp = 0.dp, top: Dp = 0.dp, end: Dp = 0.dp, bottom: Dp = 0.dp): Modifier

Works similar to padding, but the values will be mirrored according to the layout direction provided by LocalDrivingSide

fontDimensionResource

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

@Composable

fun ~~fontDimensionResource~~(@DimenRes id: Int): TextUnit

formatCountToShorterVersion

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

fun Int.formatCountToShorterVersion(): String

get

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

@Composable

inline fun <T> get(qualifier: Qualifier? = null, scope: Scope = requireNotNull(LocalViewTreeScopeOwner.current), noinline parameters: ParametersDefinition? = null): T

getAll

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

@Composable

inline fun <T> getAll(scope: Scope = requireNotNull(LocalViewTreeScopeOwner.current)): List<T>

getOrNull

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

@Composable

inline fun <T> getOrNull(qualifier: Qualifier? = null, scope: Scope = requireNotNull(LocalViewTreeScopeOwner.current), noinline parameters: ParametersDefinition? = null): T?

initWithContent

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

fun DashScopeActivity.initWithContent(content: @Composable () -> Unit)

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

fun DashScopeFragment.initWithContent(content: @Composable () -> Unit): ComposeView

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

fun ComposeView.initWithContent(scope: Scope, insetMask: Int = WindowInsetsCompat.Type.systemBars(), content: @Composable () -> Unit)

insetsPadding

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

fun Modifier.insetsPadding(): Modifier

koinViewModel

@Composable

inline fun <VM : ViewModel> koinViewModel(storeOwner: ViewModelStoreOwner = requireNotNull(LocalViewModelStoreOwner.current), viewTreeScopeOwner: Scope = requireNotNull(LocalViewTreeScopeOwner.current), noinline parameters: ParametersDefinition? = null): VM

LoadingSpinner

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

@Composable

fun LoadingSpinner(modifier: Modifier = Modifier, size: Dp)

noIndicationClickable

fun Modifier.noIndicationClickable(onClick: () -> Unit = {}): Modifier

padding

@Stable

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

fun Modifier.padding(insets: ComposeInsets): Modifier

roundOutlineButton

fun Modifier.roundOutlineButton(borderColor: Color, onClick: () -> Unit, enabled: Boolean = true): Modifier

shadow

fun Modifier.shadow(blur: Dp = 8.dp, offsetX: Dp = 0.dp, offsetY: Dp = 4.dp, alpha: Float = MAX_SHADOW_ALPHA, shape: Shape = RectangleShape, clip: Boolean = true): Modifier

Unlike androidx.compose.ui.draw.shadow, this modifier does not draw behind transparent surfaces, has predictable direction and allows for more customization

shimmer

fun Modifier.shimmer(): Modifier

SystemBarColors

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

@Composable

fun SystemBarColors(colorMode: ColorMode = ColorMode.ThemeBased, statusColorMode: ColorMode = colorMode, navigationColorMode: ColorMode = colorMode, @IntRange(from = 0, to = 255) systemBarAlpha: Int = SEMI_TRANSPARENT_ALPHA, @IntRange(from = 0, to = 255) statusBarAlpha: Int = systemBarAlpha, @IntRange(from = 0, to = 255) navigationBarAlpha: Int = systemBarAlpha, fullScreen: Boolean = false)

ViewBlockComposer

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

@Composable

inline fun <Data : Any> ViewBlockComposer(data: Data, viewBlock: ViewBlock<Data>, defaultBlock: @Composable () -> Unit = {})

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

@Composable

inline fun <Data : Any> ViewBlockComposer(data: Data, viewBlock: ViewBlock<Data>, defaultBlock: @Composable () -> Unit, loadingViewBlock: @Composable () -> Unit)

windowInsets

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

@Composable

@ReadOnlyComposable

fun windowInsets(): ComposeInsets