coui-ui/io.github.suqi8.coui.kmp.utils

Package-level declarations

Types

enum CouiHapticEffect : Enum<CouiHapticEffect>

A COUI (ColorOS) haptic effect, mapped to OPLUS linear-motor feedback constants on Android and to the closest standard haptic on every other platform.

COUIIndication

@Immutable

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

COUI default Indication that draws a rectangular state layer overlay when pressed or hovered.

COUIOverscrollEffect

class COUIOverscrollEffect : OverscrollEffect

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

COUIOverscrollFactory

object COUIOverscrollFactory : OverscrollFactory

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

COUIPopupUtils

class COUIPopupUtils

A util class for show popup and dialog.

OverScrollState

class OverScrollState

OverScrollState is used to control the overscroll effect.

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>

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

Functions

overScrollHorizontal

@Stable

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

overScrollOutOfBound

@Stable

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

@Stable

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

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.

rememberCouiHaptic

@Composable

actual fun rememberCouiHaptic(): (CouiHapticEffect) -> Unit

Performs a CouiHapticEffect. On OPLUS/ColorOS devices this invokes the matching linear-motor waveform through View.performHapticFeedback; on other Android builds and on non-Android targets it falls back to the closest standard Compose haptic.

@Composable

expect fun rememberCouiHaptic(): (CouiHapticEffect) -> Unit

@Composable

actual fun rememberCouiHaptic(): (CouiHapticEffect) -> Unit

@Composable

actual fun rememberCouiHaptic(): (CouiHapticEffect) -> Unit

@Composable

actual fun rememberCouiHaptic(): (CouiHapticEffect) -> Unit

@Composable

actual fun rememberCouiHaptic(): (CouiHapticEffect) -> Unit

scrollEndHaptic