zoomable/net.engawapg.lib.zoomable

Package-level declarations

Types

MouseWheelZoom

enum MouseWheelZoom : Enum<MouseWheelZoom>

Specifies mouse wheel zoom behaviour.

ScrollGesturePropagation

enum ScrollGesturePropagation : Enum<ScrollGesturePropagation>

ScrollGesturePropagation defines when Modifier.zoomable propagates scroll gestures to the parent composable element.

ZoomState

@Stable

class ZoomState(@FloatRange(from = 1.0) val maxScale: Float = 5.0f, contentSize: Size = Size.Zero, velocityDecay: DecayAnimationSpec<Float> = exponentialDecay(), @FloatRange(from = 1.0) initialScale: Float = 1.0f)

A state object that manage scale and offset.

Functions

rememberZoomState

@Composable

fun rememberZoomState(@FloatRange(from = 1.0) maxScale: Float = 5.0f, contentSize: Size = Size.Zero, velocityDecay: DecayAnimationSpec<Float> = exponentialDecay(), @FloatRange(from = 1.0) initialScale: Float = 1.0f): ZoomState

Creates a ZoomState that is remembered across compositions.

snapBackZoomable

fun Modifier.snapBackZoomable(zoomState: ZoomState, zoomEnabled: Boolean = true, onTap: (position: Offset) -> Unit = {}, onDoubleTap: suspend (position: Offset) -> Unit = {}, onLongPress: (position: Offset) -> Unit = {}): Modifier

A modifier function that allows content to be zoomable and automatically return to its original size when the finger is released.

toggleScale

suspend fun ZoomState.toggleScale(targetScale: Float, position: Offset, animationSpec: AnimationSpec<Float> = spring())

Toggle the scale between targetScale and 1.0f.

zoomable

fun Modifier.zoomable(zoomState: ZoomState, zoomEnabled: Boolean = true, enableOneFingerZoom: Boolean = true, scrollGesturePropagation: ScrollGesturePropagation = ScrollGesturePropagation.ContentEdge, onTap: (position: Offset) -> Unit = {}, onDoubleTap: suspend (position: Offset) -> Unit = { position -> if (zoomEnabled) zoomState.toggleScale(2.5f, position) }, onLongPress: (position: Offset) -> Unit = {}, mouseWheelZoom: MouseWheelZoom = MouseWheelZoom.EnabledWithCtrlKey): Modifier

A modifier function that allows content to be zoomable.