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

Scaffold

interface Scaffold<T : Modifier> : Layout<T>

Material Design 布局.

Scaffold 实现了基本的 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>

setBottomBar

abstract fun setBottomBar(slotBuilder: UnitScopeSlot.() -> Unit)

设置屏幕的底部栏。

setContainerColor

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

设置此 scaffold 背景的颜色。

setContent

abstract fun setContent(contentBuilder: UnitScopeSlot.(PaddingValues) -> Unit)

设置 Scaffold 的主内容区域。

setContentColor

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

设置此 scaffold 内部内容的首选颜色。

setFloatingActionButton

abstract fun setFloatingActionButton(slotBuilder: UnitScopeSlot.() -> Unit)

设置屏幕的主要操作按钮。

setFloatingActionButtonPosition

abstract fun setFloatingActionButtonPosition(position: (FabPositions) -> FabPosition)

设置 FAB 在屏幕上的位置。

setModifier

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

setSnackBarHost

abstract fun setSnackBarHost(slotBuilder: UnitScopeSlot.() -> Unit)

设置用于承载 Snackbar 的组件。

setTopBar

abstract fun setTopBar(slotBuilder: UnitScopeSlot.() -> Unit)

设置屏幕的顶部应用栏。

setVisible

abstract fun setVisible(visible: Boolean)

设置显示/隐藏当前 Composable

SideEffect

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

trackAggregatedState

abstract fun trackAggregatedState(state: AggregatedState)

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

trackSingleState

abstract fun trackSingleState(state: SingleState)

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

Scaffold

Author

See also

Functions