miuix-ui/top.yukonga.miuix.kmp.utils

Package-level declarations

Types

class MiuixIndication(color: Color = Color.Black) : IndicationNodeFactory

Miuix default Indication that draws a rectangular overlay when pressed.

class MiuixOverscrollEffect : OverscrollEffect

Spring overscroll sharing damping and spring physics with overScrollVertical and overScrollHorizontal. Axes settle independently and coordinate with pull-to-refresh.

MiuixOverscrollFactory

object MiuixOverscrollFactory : OverscrollFactory

Creates MiuixOverscrollEffect instances for Compose scrollables. Provided by top.yukonga.miuix.kmp.theme.MiuixTheme through androidx.compose.foundation.LocalOverscrollFactory.

MiuixPopupUtils

class MiuixPopupUtils

A util class for show popup and dialog.

OverScrollState

class OverScrollState

Tracks whether overscroll is active.

PagerFlingTrackerConnection

class PagerFlingTrackerConnection : NestedScrollConnection

Tracks child vertical flings and coordinates PagerInterceptionMode.TapToHalt requests.

PagerGestureNestedScrollConnection

object PagerGestureNestedScrollConnection : NestedScrollConnection

Leaves vertical scroll and velocity to page content, including between pages.

PagerInterceptionMode

enum PagerInterceptionMode : Enum<PagerInterceptionMode>

Horizontal pager behavior when a child scrollable is flinging or overscrolling.

PressFeedbackType

enum PressFeedbackType : Enum<PressFeedbackType>

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

SinkFeedback

@Stable

data class SinkFeedback(val sinkAmount: Float = 0.94f, val animationSpec: AnimationSpec<Float> = spring(0.8f, 600f)) : IndicationNodeFactory

TiltFeedback

@Stable

data class TiltFeedback(val tiltAmount: Float = 8.0f, val animationSpec: AnimationSpec<Float> = spring(0.6f, 400f)) : IndicationNodeFactory

Properties

LocalOverScrollState

val LocalOverScrollState: ProvidableCompositionLocal<OverScrollState>

Shared overscroll state for scroll and pull-to-refresh coordination.

PagerNavigationSpringSpec

val PagerNavigationSpringSpec: SpringSpec<Float>

Spring spec shared by pager tab navigation and snap fling.

Functions

horizontalPagerSwipeOverride

fun Modifier.horizontalPagerSwipeOverride(pagerState: PagerState, enabled: Boolean = true, onIntercepted: () -> Unit? = null): Modifier

Drives horizontal drag and settling in one PagerState.scroll mutation. New touches take over at the displayed position; vertical gestures stay with children.

iosStyleMomentumHalt

fun Modifier.iosStyleMomentumHalt(flingTracker: PagerFlingTrackerConnection, enabled: Boolean = true, onHalted: () -> Unit? = null): Modifier

Requests a child fling halt on touch down and consumes that gesture's horizontal drag. When no child fling is active, leaves horizontal swipes to the native pager.

overScrollHorizontal

@Stable

fun Modifier.overScrollHorizontal(nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { true }): Modifier

overScrollOutOfBound

@Stable

fun Modifier.overScrollOutOfBound(isVertical: Boolean = true, nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { true }): Modifier

Overscroll effect when scrolling to the boundary.

overScrollVertical

@Stable

fun Modifier.overScrollVertical(nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { true }): Modifier

pagerGestureOverride

@Composable

fun Modifier.pagerGestureOverride(pagerState: PagerState, mode: Int, enabled: Boolean = true, onTriggered: () -> Unit? = null): Modifier

fun Modifier.pagerGestureOverride(pagerState: PagerState, mode: Int, enabled: Boolean = true, flingTracker: PagerFlingTrackerConnection? = null, onTriggered: () -> Unit? = null): Modifier

Accepts a stored mode ordinal; invalid values select PagerInterceptionMode.Native.

@Composable

fun Modifier.pagerGestureOverride(pagerState: PagerState, mode: PagerInterceptionMode = PagerInterceptionMode.CrossAxisInterceptor, enabled: Boolean = true, onTriggered: () -> Unit? = null): Modifier

Applies mode with a remembered PagerFlingTrackerConnection. See horizontalPagerSwipeOverride for Cross-Axis pager configuration.

fun Modifier.pagerGestureOverride(pagerState: PagerState, mode: PagerInterceptionMode = PagerInterceptionMode.CrossAxisInterceptor, enabled: Boolean = true, flingTracker: PagerFlingTrackerConnection? = null, onTriggered: () -> Unit? = null): Modifier

Applies mode to a HorizontalPager.

pressable

@Stable

fun Modifier.pressable(interactionSource: MutableInteractionSource?, indication: Indication? = null, enabled: Boolean = true, role: Role? = null, delay: Long? = TAP_INDICATION_DELAY): Modifier

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

scrollEndHaptic

fun Modifier.scrollEndHaptic(hapticFeedbackType: HapticFeedbackType = HapticFeedbackType.TextHandleMove): Modifier

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

springAnimateToPage

suspend fun PagerState.springAnimateToPage(target: Int)

Animates to target using PagerNavigationSpringSpec after the first layout. Uses MutatePriority.UserInput so focus scrolling cannot interrupt the animation.

WindowNavigationEventScope

@Composable

actual fun WindowNavigationEventScope(content: () -> Unit)

Rebinds back-event handling to the platform window hosting content.

@Composable

expect fun WindowNavigationEventScope(content: @Composable () -> Unit)

Rebinds back-event handling to the platform window hosting content.

@Composable

actual fun WindowNavigationEventScope(content: () -> Unit)

Rebinds back-event handling to the platform window hosting content.