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

SwipeToDismissBox

interface SwipeToDismissBox<T : Modifier> : Layout<T>

一个可以通过向左或向右滑动来关闭的 Composable。

Author

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

See also

androidx.compose.material3.SwipeToDismissBox

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>

setBackgroundContent

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

设置堆叠在内容后面的 Composable，当内容被滑动时会暴露出来。

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

设置可以被关闭的内容。

setEnableDismissFromEndToStart

abstract fun setEnableDismissFromEndToStart(enable: Boolean)

设置是否可以从结束到起始方向滑动来关闭。

setEnableDismissFromStartToEnd

abstract fun setEnableDismissFromStartToEnd(enable: Boolean)

设置是否可以从起始到结束方向滑动来关闭。

setGesturesEnabled

abstract fun setGesturesEnabled(enabled: Boolean)

设置是否可以通过手势进行滑动关闭交互。

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

abstract fun setState(state: SwipeToDismissBoxState)

设置此组件的状态控制器。

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 会重组