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

BottomSheetScaffold

interface BottomSheetScaffold<T : Modifier> : Layout<T>

Material 3 BottomSheetScaffold Composable 的参数接口。

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(contentBuilder: UnitScopeSlot.(PaddingValues) -> Unit)

设置屏幕的主要内容。

setContentColor

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

设置此脚手架内部内容的首选颜色。

setModifier

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

setScaffoldState

abstract fun setScaffoldState(scaffoldState: BottomSheetScaffoldState)

设置此脚手架的状态。

setSheetContainerColor

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

设置底部工作表的背景颜色。

setSheetContent

abstract fun setSheetContent(sheetContentBuilder: ColumnScopeSlot.() -> Unit)

设置底部工作表的内容。

setSheetContentColor

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

设置底部工作表内部内容的首选颜色。

setSheetDragHandle

abstract fun setSheetDragHandle(dragHandleBuilder: UnitScopeSlot.() -> Unit)

设置一个可选的可视化标记，用于拖动底部工作表。

setSheetPeekHeight

abstract fun setSheetPeekHeight(value: (Dimensions) -> Dp)

设置当底部工作表折叠时的高度。

setSheetShadowElevation

abstract fun setSheetShadowElevation(value: (Dimensions) -> Dp)

设置底部工作表的阴影高度。

setSheetShape

abstract fun setSheetShape(shapeBuilder: (Shapes) -> Shape)

设置底部工作表的形状。

setSheetSwipeEnabled

abstract fun setSheetSwipeEnabled(enabled: Boolean)

设置是否启用工作表的滑动手势。

setSheetTonalElevation

abstract fun setSheetTonalElevation(value: (Dimensions) -> Dp)

设置底部工作表的色调高度。

setSnackBarHost

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

设置用于承载 SnackBar 的自定义组件。

setTopBar

abstract fun setTopBar(topBarBuilder: 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 会重组