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

TopAppBar

interface TopAppBar<T : Modifier> : Layout<T>

所有 TopAppBar 可组合函数的通用参数接口。

Author

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

Inheritors

CenterAlignedTopAppBar

MediumTopAppBar

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>

abstract fun setActions(slotBuilder: RowScopeSlot.() -> Unit)

设置显示在 TopAppBar 末尾的操作图标。 Slot 的接收者类型应为 RowScope。

abstract fun setColors(colorsBuilder: TopAppBarColors.() -> Unit)

设置用于解析此 TopAppBar 颜色的 TopAppBarColors。

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

setNavigationIcon

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

设置显示在 TopAppBar 开头的导航图标。

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

设置要在 TopAppBar 中显示的标题。

abstract fun setVisible(visible: Boolean)

设置显示/隐藏当前 Composable

setWindowInsets

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

设置将通过 PaddingValues 参数传递给内容区域的窗口边衬区。

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

trackAggregatedState

abstract fun trackAggregatedState(state: AggregatedState)

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

trackSingleState

abstract fun trackSingleState(state: SingleState)

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