sdk/com.m8test.script.core.api.ui.compose.widget/NavigationBar

NavigationBar

interface NavigationBar<T : Modifier> : Layout<T>

代表一个 Material Design 风格的底部导航栏。导航栏为应用内的主要目标页面切换提供了一种持久且便捷的方式。本接口是对 Jetpack Compose androidx.compose.material3.NavigationBar 组件的封装。一个导航栏通常应包含三到五个 NavigationBarItem。

Author

M8Test, [email protected], https://m8test.com

See also

Material Design Navigation Bar

Functions

DisposableEffect

abstract fun DisposableEffect(disposableEffectBuilder: DisposableEffect.() -> Unit)

getCompositionLocal

abstract fun <T> getCompositionLocal(name: String): ProvidableCompositionLocal<T>?

getCompositionLocalValue

abstract fun <V> getCompositionLocalValue(compositionLocal: ProvidableCompositionLocal<V>): V?

获取 compositionLocal 的值

abstract fun getContext(): ScriptContext

获取脚本上下文对象 ScriptContext.

abstract fun LaunchedEffect(launchedEffectBuilder: LaunchedEffect.() -> Unit)

LocalColorScheme

abstract fun LocalColorScheme(): ProvidableCompositionLocal<ColorScheme>

LocalContentColor

abstract fun LocalContentColor(): ProvidableCompositionLocal<Color>

abstract fun LocalShapes(): ProvidableCompositionLocal<Shapes>

abstract fun LocalTextStyle(): ProvidableCompositionLocal<TextStyle>

LocalTypography

abstract fun LocalTypography(): ProvidableCompositionLocal<Typography>

setContainerColor

abstract fun setContainerColor(colorBuilder: Color.() -> Unit)

设置此导航栏的背景颜色。使用 Color.Transparent 可实现透明背景。

abstract fun setContent(contentBuilder: RowScopeSlot.() -> Unit)

设置此导航栏的内容，通常是 3-5 个 NavigationBarItem。

setContentColor

abstract fun setContentColor(colorBuilder: Color.() -> Unit)

设置此导航栏内部内容（如图标和文本）的首选颜色。默认情况下，它会根据 getContainerColor 自动匹配相应的内容颜色；如果容器颜色不是来自主题，则使用当前环境的局部内容颜色。

abstract fun setModifier(modifierBuilder: T.() -> Unit)

setTonalElevation

abstract fun setTonalElevation(elevation: (Dimensions) -> Dp)

设置色调高度。当容器颜色为 ColorScheme.surface 时，一个半透明的主题色叠加层会被应用在容器之上。更高的色调高度值在亮色主题下会产生更深的颜色，在暗色主题下会产生更浅的颜色。

abstract fun setVisible(visible: Boolean)

设置显示/隐藏当前 Composable

abstract fun SideEffect(sideEffectBuilder: SideEffect.() -> Unit)

trackAggregatedState

abstract fun trackAggregatedState(state: AggregatedState)

设置所有需要用到的聚合状态,例如 DrawerState, BottomSheetState 等

trackSingleState

abstract fun trackSingleState(state: SingleState)

添加当前 Composable 需要监听的状态，如果状态改变的话 Composable 会重组