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

NavigationRail

interface NavigationRail<T : Modifier> : Layout<T>

Material Design 导航栏.

导航栏在使用平板和桌面屏幕时提供对应用程序主要目标的访问。

Author

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

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 的值

getContext

abstract fun getContext(): ScriptContext

获取脚本上下文对象 ScriptContext.

LaunchedEffect

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

LocalColorScheme

abstract fun LocalColorScheme(): ProvidableCompositionLocal<ColorScheme>

LocalContentColor

abstract fun LocalContentColor(): ProvidableCompositionLocal<Color>

LocalShapes

abstract fun LocalShapes(): ProvidableCompositionLocal<Shapes>

LocalTextStyle

abstract fun LocalTextStyle(): ProvidableCompositionLocal<TextStyle>

LocalTypography

abstract fun LocalTypography(): ProvidableCompositionLocal<Typography>

setContainerColor

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

设置此导航栏背景的颜色。

setContent

abstract fun setContent(slotBuilder: ColumnScopeSlot.() -> Unit)

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

setContentColor

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

设置此导航栏内部内容的首选颜色。

setHeader

abstract fun setHeader(slotBuilder: ColumnScopeSlot.() -> Unit)

设置可选的头部内容，可能包含一个浮动操作按钮（FAB）或 Logo。

setModifier

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

setVisible

abstract fun setVisible(visible: Boolean)

设置显示/隐藏当前 Composable

setWindowInsets

abstract fun setWindowInsets(windowInsets: (WindowInsetsProviders) -> WindowInsets)

设置导航栏的窗口边衬区。

SideEffect

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

trackAggregatedState

abstract fun trackAggregatedState(state: AggregatedState)

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

trackSingleState

abstract fun trackSingleState(state: SingleState)

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

NavigationRail

Author

See also

Functions