kvadrant-core/io.github.youndie.kvadrant.indication

Package-level declarations

Types

class KvadrantOverscroll(scope: CoroutineScope, maxOffset: Float = DEFAULT_MAX_OFFSET, resistance: Float = DEFAULT_RESISTANCE, flingReference: Float = DEFAULT_FLING_REFERENCE) : OverscrollEffect

The end of a list, the way Windows Phone ended one: the content follows the finger past the boundary, showing the page behind it, and rubber-bands back when it lets go.

KvadrantOverscrollFactory

class KvadrantOverscrollFactory(scope: CoroutineScope, maxOffset: Float = KvadrantOverscroll.DEFAULT_MAX_OFFSET, resistance: Float = KvadrantOverscroll.DEFAULT_RESISTANCE, flingReference: Float = KvadrantOverscroll.DEFAULT_FLING_REFERENCE) : OverscrollFactory

Hands KvadrantTheme an effect per scrolling surface, the way an indication is handed out.

Tilt

object Tilt

The tilt geometry of Windows Phone, transcribed from TiltEffect.cs (the RTM algorithm, "direct from the shell team"): a press rotates the plane towards the finger and pushes it away from the viewer, by an amount that trades off against the rotation.

TiltIndication

class TiltIndication(cameraDistance: Dp = DEFAULT_CAMERA_DISTANCE, maxDepression: Dp = Tilt.maxDepression, animatePress: Boolean = false, focusRingThickness: Dp = KvadrantMetrics().focusRingThickness, sharedCamera: Boolean = false) : IndicationNodeFactory

Metro's press feedback, in the slot Material fills with a ripple — and, since B-40, the keyboard focus ring that goes in the same slot.

TiltTransform

data class TiltTransform(val rotationX: Float, val rotationY: Float, val depression: Dp)

Where the plane ends up for a press at position on a surface of size.

Functions

kvadrantTilt

fun Modifier.kvadrantTilt(enabled: Boolean = true, interactionSource: MutableInteractionSource? = null, onClick: () -> Unit): Modifier

A press that keeps leaning towards the finger as it moves, the way the original did.

tiltFor

fun tiltFor(position: Offset, size: Size, maxDepression: Dp = Tilt.maxDepression): TiltTransform

tiltReturn

fun tiltReturn(millisSinceRelease: Long): Float

How much of the tilt is still applied, millisSinceRelease after the finger left.