Package-level declarations

Types

Link copied to clipboard

Miuix default Indication that draws a rectangular overlay when pressed.

Link copied to clipboard

A Miuix OverscrollEffect implementing spring-based overscroll physics identical to overScrollVertical and overScrollHorizontal.

Link copied to clipboard

A Miuix implementation of OverscrollFactory that creates OverscrollEffect instances with the same spring-based overscroll physics as overScrollVertical and overScrollHorizontal.

Link copied to clipboard

A util class for show popup and dialog.

Link copied to clipboard

OverScrollState is used to control the overscroll effect.

Link copied to clipboard

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

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

Properties

Link copied to clipboard

Functions

Link copied to clipboard
fun Modifier.overScrollHorizontal(nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier
Link copied to clipboard
fun Modifier.overScrollOutOfBound(isVertical: Boolean = true, nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

Overscroll effect when scrolling to the boundary.

Link copied to clipboard
fun Modifier.overScrollVertical(nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier
Link copied to clipboard
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.

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.