miuix/top.yukonga.miuix.kmp.utils

Package-level declarations

Types

Link copied to clipboard
@Immutable
data class BackEventCompat(val progress: Float, val swipeEdge: Int = 0, val touchX: Float = 0.0f, val touchY: Float = 0.0f)

Data class representing the progress of a predictive back gesture.

Link copied to clipboard
@Immutable
class MiuixIndication(color: Color = Color.Black) : IndicationNodeFactory

Miuix default Indication that draws a rectangular overlay when pressed.

Link copied to clipboard
class MiuixPopupUtils

A util class for show popup and dialog.

Link copied to clipboard
class OverScrollState

OverScrollState is used to control the overscroll effect.

Link copied to clipboard
enum Platform : Enum<Platform>

Platform enum class.

Link copied to clipboard
enum PressFeedbackType : Enum<PressFeedbackType>

The type of visual feedback to apply when the component is pressed.

Link copied to clipboard
@Immutable
data class SinkFeedback(val sinkAmount: Float = 0.94f, val animationSpec: AnimationSpec<Float> = spring(0.8f, 600f)) : IndicationNodeFactory
Link copied to clipboard
@Immutable
data class TiltFeedback(val tiltAmount: Float = 8.0f, val animationSpec: AnimationSpec<Float> = spring(0.6f, 400f)) : IndicationNodeFactory
Link copied to clipboard
@Immutable
data class WindowSize(val width: Int, val height: Int)

Window size data class.

Properties

Link copied to clipboard

Functions

Link copied to clipboard
@Composable
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
@Composable
expect fun BackHandler(enabled: Boolean, onBack: () -> Unit)

Handles the back event.

@Composable
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
@Composable
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
@Composable
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
@Composable
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
Link copied to clipboard
fun getCornerRadiusBottom(context: Context): Int
Link copied to clipboard
@Composable
actual fun getRoundedCorner(): Dp
@Composable
expect fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

@Composable
actual fun getRoundedCorner(): Dp
@Composable
actual fun getRoundedCorner(): Dp
@Composable
actual fun getRoundedCorner(): Dp
actual fun getRoundedCorner(): Dp
@Composable
actual fun getRoundedCorner(): Dp
Link copied to clipboard
@Composable
actual fun getWindowSize(): WindowSize
@Composable
expect fun getWindowSize(): WindowSize

Returns the current window size.

@Composable
actual fun getWindowSize(): WindowSize
@Composable
actual fun getWindowSize(): WindowSize
@Composable
actual fun getWindowSize(): WindowSize
actual fun getWindowSize(): WindowSize
@Composable
actual fun getWindowSize(): WindowSize
Link copied to clipboard
@Stable
fun Modifier.overScrollHorizontal(nestedScrollToParent: Boolean = true, scrollEasing: (distance: Float, range: Int) -> Float? = null, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier
Link copied to clipboard
@Stable
fun Modifier.overScrollOutOfBound(isVertical: Boolean = true, nestedScrollToParent: Boolean = true, scrollEasing: (distance: Float, range: Int) -> Float?, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

Overscroll effect when scrolling to the boundary.

Link copied to clipboard
@Stable
fun Modifier.overScrollVertical(nestedScrollToParent: Boolean = true, scrollEasing: (distance: Float, range: Int) -> Float? = null, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier
Link copied to clipboard
actual fun platform(): Platform
expect fun platform(): Platform

Returns the current platform name.

actual fun platform(): Platform
actual fun platform(): Platform
actual fun platform(): Platform
actual fun platform(): Platform
actual fun platform(): Platform
Link copied to clipboard
@Composable
actual fun PredictiveBackHandler(enabled: Boolean, onBackStarted: (BackEventCompat) -> Unit?, onBackProgressed: (BackEventCompat) -> Unit?, onBackCancelled: () -> Unit?, onBack: () -> Unit)
@Composable
expect fun PredictiveBackHandler(enabled: Boolean = true, onBackStarted: (BackEventCompat) -> Unit? = null, onBackProgressed: (BackEventCompat) -> Unit? = null, onBackCancelled: () -> Unit? = null, onBack: () -> Unit)

Handles the predictive back gesture with callbacks for different stages. On non-Android platforms, this falls back to simple BackHandler behavior.

@Composable
actual fun PredictiveBackHandler(enabled: Boolean, onBackStarted: (BackEventCompat) -> Unit?, onBackProgressed: (BackEventCompat) -> Unit?, onBackCancelled: () -> Unit?, onBack: () -> Unit)
@Composable
actual fun PredictiveBackHandler(enabled: Boolean, onBackStarted: (BackEventCompat) -> Unit?, onBackProgressed: (BackEventCompat) -> Unit?, onBackCancelled: () -> Unit?, onBack: () -> Unit)
@Composable
actual fun PredictiveBackHandler(enabled: Boolean, onBackStarted: (BackEventCompat) -> Unit?, onBackProgressed: (BackEventCompat) -> Unit?, onBackCancelled: () -> Unit?, onBack: () -> Unit)
actual fun PredictiveBackHandler(enabled: Boolean, onBackStarted: (BackEventCompat) -> Unit?, onBackProgressed: (BackEventCompat) -> Unit?, onBackCancelled: () -> Unit?, onBack: () -> Unit)
@Composable
actual fun PredictiveBackHandler(enabled: Boolean, onBackStarted: (BackEventCompat) -> Unit?, onBackProgressed: (BackEventCompat) -> Unit?, onBackCancelled: () -> Unit?, onBack: () -> Unit)
Link copied to clipboard
@Stable
fun Modifier.pressable(enabled: Boolean = true, role: Role? = null, delay: Long? = TapIndicationDelay): Modifier
@Stable
fun Modifier.pressable(interactionSource: MutableInteractionSource?, indication: Indication? = null, enabled: Boolean = true, role: Role? = null, delay: Long? = TapIndicationDelay): Modifier

Configure component to receive press via accessibility "press" event.

Link copied to clipboard
fun Modifier.scrollEndHaptic(hapticFeedbackType: HapticFeedbackType = HapticFeedbackType.TextHandleMove): Modifier

Applies a haptic feedback effect when a scrollable container is flung to its boundaries.

Generated by Dokka
© 2025 Copyright