miuix/top.yukonga.miuix.kmp.utils

Package-level declarations

Types

MiuixIndication

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

Miuix default Indication that draws a rectangular overlay when pressed.

MiuixOverscrollEffect

class MiuixOverscrollEffect : OverscrollEffect

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

MiuixOverscrollFactory

object MiuixOverscrollFactory : OverscrollFactory

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

MiuixPopupUtils

class MiuixPopupUtils

A util class for show popup and dialog.

OverScrollState

class OverScrollState

OverScrollState is used to control the overscroll effect.

enum Platform : Enum<Platform>

Platform enum class.

PressFeedbackType

enum PressFeedbackType : Enum<PressFeedbackType>

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

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

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

Properties

hasFocusReassignBug

actual val hasFocusReassignBug: Boolean

Whether the platform has a bug where clearing focus causes automatic re-assignment to the first focusable view. This occurs on Android API levels 26-27.

expect val hasFocusReassignBug: Boolean

Whether the platform has a bug where clearing focus causes automatic re-assignment to the first focusable view. This occurs on Android API levels 26-27.

actual val hasFocusReassignBug: Boolean = false

Whether the platform has a bug where clearing focus causes automatic re-assignment to the first focusable view. This occurs on Android API levels 26-27.

actual val hasFocusReassignBug: Boolean = false

Whether the platform has a bug where clearing focus causes automatic re-assignment to the first focusable view. This occurs on Android API levels 26-27.

actual val hasFocusReassignBug: Boolean = false

Whether the platform has a bug where clearing focus causes automatic re-assignment to the first focusable view. This occurs on Android API levels 26-27.

actual val hasFocusReassignBug: Boolean = false

Whether the platform has a bug where clearing focus causes automatic re-assignment to the first focusable view. This occurs on Android API levels 26-27.

actual val hasFocusReassignBug: Boolean = false

Whether the platform has a bug where clearing focus causes automatic re-assignment to the first focusable view. This occurs on Android API levels 26-27.

LocalOverScrollState

val LocalOverScrollState: ProvidableCompositionLocal<OverScrollState>

LocalOverScrollState is used to provide the OverScrollState instance to the composition.

Functions

getCornerRadiusBottom

fun getCornerRadiusBottom(context: Context): Int

getRoundedCorner

actual fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

expect fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

actual fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

actual fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

actual fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

actual fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

actual fun getRoundedCorner(): Dp

Returns the rounded corner of the current device.

overScrollHorizontal

fun Modifier.overScrollHorizontal(nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

overScrollOutOfBound

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.

overScrollVertical

fun Modifier.overScrollVertical(nestedScrollToParent: Boolean = true, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

actual fun platform(): Platform

Returns the current platform name.

expect fun platform(): Platform

Returns the current platform name.

actual fun platform(): Platform

Returns the current platform name.

actual fun platform(): Platform

Returns the current platform name.

actual fun platform(): Platform

Returns the current platform name.

actual fun platform(): Platform

Returns the current platform name.

actual fun platform(): Platform

Returns the current platform name.

platformDialogProperties

actual fun platformDialogProperties(): DialogProperties

Returns platform-specific DialogProperties.

expect fun platformDialogProperties(): DialogProperties

Returns platform-specific DialogProperties.

actual fun platformDialogProperties(): DialogProperties

Returns platform-specific DialogProperties.

actual fun platformDialogProperties(): DialogProperties

Returns platform-specific DialogProperties.

actual fun platformDialogProperties(): DialogProperties

Returns platform-specific DialogProperties.

actual fun platformDialogProperties(): DialogProperties

Returns platform-specific DialogProperties.

actual fun platformDialogProperties(): DialogProperties

Returns platform-specific DialogProperties.

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.

RemovePlatformDialogDefaultEffects

actual fun RemovePlatformDialogDefaultEffects()

Removes platform default dialog effects such as window animations and dimming.

expect fun RemovePlatformDialogDefaultEffects()

Removes platform default dialog effects such as window animations and dimming.

actual fun RemovePlatformDialogDefaultEffects()

Removes platform default dialog effects such as window animations and dimming.

actual fun RemovePlatformDialogDefaultEffects()

Removes platform default dialog effects such as window animations and dimming.

actual fun RemovePlatformDialogDefaultEffects()

Removes platform default dialog effects such as window animations and dimming.

actual fun RemovePlatformDialogDefaultEffects()

Removes platform default dialog effects such as window animations and dimming.

actual fun RemovePlatformDialogDefaultEffects()

Removes platform default dialog effects such as window animations and dimming.

scrollEndHaptic

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

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