miuix/top.yukonga.miuix.kmp.utils

Package-level declarations

Types

Link copied to clipboard
object ColorUtils
Link copied to clipboard
@Immutable
data class CornerSmoothness(@FloatRange(from = 0.0, to = 1.0) val circleFraction: Float, @FloatRange(from = 0.0) val extendedFraction: Float)
Link copied to clipboard
@Immutable
open class G2RoundedCornerShape(topStart: CornerSize, topEnd: CornerSize, bottomEnd: CornerSize, bottomStart: CornerSize, val cornerSmoothness: CornerSmoothness = CornerSmoothness.Default) : CornerBasedShape
Link copied to clipboard
data class Hsv(val h: Double, val v: Double, val s: Double)

User-friendly HSV-like representation.

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
data class OkLab(val l: Double, val a: Double, val b: Double)

User-friendly OkLab representation.

Link copied to clipboard
@Stable
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
data class WindowSize(val width: Int, val height: Int)

Window size data class.

Properties

Link copied to clipboard
Link copied to clipboard
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)
@Composable
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
@Composable
actual fun BackHandler(enabled: Boolean, onBack: () -> Unit)
Link copied to clipboard
@Stable
fun CapsuleShape(cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
Link copied to clipboard
@Stable
fun G2RoundedCornerShape(corner: CornerSize, cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
@Stable
fun G2RoundedCornerShape(size: Dp, cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
@Stable
fun G2RoundedCornerShape(@FloatRange(from = 0.0) size: Float, cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
@Stable
fun G2RoundedCornerShape(@IntRange(from = 0, to = 100) percent: Int, cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
@Stable
fun G2RoundedCornerShape(topStart: Dp = 0.dp, topEnd: Dp = 0.dp, bottomEnd: Dp = 0.dp, bottomStart: Dp = 0.dp, cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
@Stable
fun G2RoundedCornerShape(@FloatRange(from = 0.0) topStart: Float = 0.0f, @FloatRange(from = 0.0) topEnd: Float = 0.0f, @FloatRange(from = 0.0) bottomEnd: Float = 0.0f, @FloatRange(from = 0.0) bottomStart: Float = 0.0f, cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
@Stable
fun G2RoundedCornerShape(@IntRange(from = 0, to = 100) topStartPercent: Int = 0, @IntRange(from = 0, to = 100) topEndPercent: Int = 0, @IntRange(from = 0, to = 100) bottomEndPercent: Int = 0, @IntRange(from = 0, to = 100) bottomStartPercent: Int = 0, cornerSmoothness: CornerSmoothness = CornerSmoothness.Default): G2RoundedCornerShape
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
@Composable
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
@Composable
actual fun getWindowSize(): WindowSize
@Composable
actual fun getWindowSize(): WindowSize
Link copied to clipboard
@Stable
fun Modifier.overScrollHorizontal(nestedScrollToParent: Boolean = true, scrollEasing: (currentOffset: Float, newOffset: Float) -> 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: (currentOffset: Float, newOffset: Float) -> Float?, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier

OverScroll effect for scrollable Composable.

Link copied to clipboard
@Stable
fun Modifier.overScrollVertical(nestedScrollToParent: Boolean = true, scrollEasing: (currentOffset: Float, newOffset: Float) -> Float? = null, springStiff: Float = OutBoundSpringStiff, springDamp: Float = OutBoundSpringDamp, isEnabled: () -> Boolean = { platform() == Platform.Android || platform() == Platform.IOS }): Modifier
Link copied to clipboard
@Stable
fun parabolaScrollEasing(currentOffset: Float, newOffset: Float, p: Float = 50.0f, density: Float): Float

A parabolic rolling easing curve.

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
fun Modifier.pressable(enabled: Boolean = true, role: Role? = null, delay: Long? = TapIndicationDelay): Modifier
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.

Link copied to clipboard
fun Color.toHsv(): Hsv

Convert Compose Color to Hvs.

Link copied to clipboard
fun Color.toOkLab(): OkLab

Convert Compose Color to user-friendly OkLab.