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

Switch

interface Switch<T : Modifier> : Widget<T> , Interactable

Material Design 开关.

开关用于切换单个项目的开启或关闭状态。

Author

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

See also

androidx.compose.material3.Switch

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 setChecked(value: Boolean)

设置此开关是否被选中。

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

设置用于解析此开关在不同状态下颜色的 SwitchColors。

abstract fun setEnabled(value: Boolean)

设置是否启用此开关。

setInteractionSource

abstract fun setInteractionSource(interactionSource: MutableInteractionSource)

设置用于观察和发出此组件交互的 MutableInteractionSource。

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

setOnCheckedChange

abstract fun setOnCheckedChange(callback: (Boolean) -> Unit)

设置当此开关被点击时调用的回调。

setThumbContent

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

设置将绘制在滑块内部的内容，通常是一个图标。

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