compose-multiplatform-html-unified-common/com.huanshankeji.compose.foundation

Package-level declarations

Types

data class BorderStroke(val width: Dp, val brush: Brush)

@RequiresOptIn(message = "This foundation API is experimental and is likely to change or be removed in the future. See `androidx.compose.foundation.ExperimentalFoundationApi`.")

annotation class ExperimentalFoundationApi

ScrollState

@Stable

expect class ScrollState

Not working on JS yet and delegating to Unit.

actual typealias ScrollState = androidx.compose.foundation.ScrollState

typealias ScrollState = androidx.compose.foundation.ScrollState

@Stable

actual class ScrollState

Properties

imitateComposeUiLayoutHorizontalScrollPlatformModifier

val imitateComposeUiLayoutHorizontalScrollPlatformModifier: Modifier

imitateComposeUiLayoutVerticalScrollPlatformModifier

val imitateComposeUiLayoutVerticalScrollPlatformModifier: Modifier

SCROLL_MODIFIER_DEPRECATION_MESSAGE

const val SCROLL_MODIFIER_DEPRECATION_MESSAGE: String

Functions

background

expect fun Modifier.background(color: Color): Modifier

For consistency on different platforms, if used with a padding modifier, use with Modifier.outerPadding and use after it, because the padding is not within the background. Otherwise, add an outer Box and use background on it.

actual fun Modifier.background(color: Color): Modifier

border

@Stable

expect fun Modifier.border(border: BorderStroke): Modifier

@Stable

expect fun Modifier.border(width: Dp, color: Color): Modifier

@Stable

actual fun Modifier.border(border: BorderStroke): Modifier

@Stable

actual fun Modifier.border(width: Dp, color: Color): Modifier

@Stable

actual fun Modifier.border(border: BorderStroke): Modifier

@Stable

actual fun Modifier.border(width: Dp, color: Color): Modifier

clickable

expect fun Modifier.clickable(onClick: () -> Unit): Modifier

Has the interactive effect when clicked on the composeUi targets.

actual fun Modifier.clickable(onClick: () -> Unit): Modifier

horizontalScroll

expect fun Modifier.~~horizontalScroll~~(state: ScrollState): Modifier

For consistency on different platforms, components such as HorizontalScrollContainer, HorizontalScrollBox, HorizontalScrollRow are recommended over this modifier.

actual fun Modifier.horizontalScroll(state: ScrollState): Modifier

fun PlatformModifier.horizontalScroll(): Modifier

actual fun Modifier.horizontalScroll(state: ScrollState): Modifier

HorizontalScrollBox

@Composable

fun ~~HorizontalScrollBox~~(boxModifier: Modifier = Modifier, contentModifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, content: @Composable BoxScope.() -> Unit)

onClick

actual fun Modifier.onClick(onClick: () -> Unit): Modifier

expect fun Modifier.~~onClick~~(onClick: () -> Unit): Modifier

Delegates to clickable on Android. onClick is not available on Android. See https://github.com/JetBrains/compose-multiplatform/issues/4468 for details.

actual fun Modifier.onClick(onClick: () -> Unit): Modifier

rememberScrollState

@Composable

expect fun rememberScrollState(initial: Int = 0): ScrollState

@Composable

actual fun rememberScrollState(initial: Int): ScrollState

@Composable

actual fun rememberScrollState(initial: Int): ScrollState

toPlatformValue

fun BorderStroke.toPlatformValue(): BorderStroke

verticalScroll

expect fun Modifier.~~verticalScroll~~(state: ScrollState): Modifier

Note that if the component is a layout, for example a Material card, it applies to the target as a whole on Compose UI targets, but applies to its content on JS DOM. For consistency on different platforms, components such as VerticalScrollContainer, VerticalScrollBox, VerticalScrollColumn are recommended over this modifier.

actual fun Modifier.verticalScroll(state: ScrollState): Modifier

fun PlatformModifier.verticalScroll(): Modifier

actual fun Modifier.verticalScroll(state: ScrollState): Modifier

VerticalScrollBox

@Composable

fun ~~VerticalScrollBox~~(boxModifier: Modifier = Modifier, contentModifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, content: @Composable BoxScope.() -> Unit)