zoomable/me.saket.telephoto.zoomable

Package-level declarations

Types

Implement this interface for reacting to double clicks on Modifier.zoomable's content. By default, ToggleBetweenMinAndMax is used.

HardwareShortcutDetector

@Immutable

interface HardwareShortcutDetector

Detects zoom and pan events made using keyboard and mouse shortcuts.

HardwareShortcutsSpec

@Immutable

class HardwareShortcutsSpec(val enabled: Boolean = true, val shortcutDetector: HardwareShortcutDetector = HardwareShortcutDetector.Default)

Describes how keyboard and mouse shortcuts are handled. When enabled, Modifier.zoomable's content will participate in the focus system to receive hardware events.

ZoomableContentLocation

interface ZoomableContentLocation

Modifier.zoomable uses ZoomableContentLocation to understand the content's visual size and position in order to prevent it from going out of bounds during pan & zoom gestures.

ZoomableContentTransformation

@Immutable

interface ZoomableContentTransformation

Graphics transformations generated by Modifier.zoomable when pan & zoom gestures are received.

ZoomableState

@Stable

interface ZoomableState

ZoomSpec

@Immutable

class ZoomSpec(val maxZoomFactor: Float = 2.0f, val preventOverOrUnderZoom: Boolean = true)

Functions

rememberZoomableState

@Composable

fun rememberZoomableState(zoomSpec: ZoomSpec = ZoomSpec(), autoApplyTransformations: Boolean = true, hardwareShortcutsSpec: HardwareShortcutsSpec = HardwareShortcutsSpec()): ZoomableState

Create a ZoomableState that can be used with Modifier.zoomable.

zoomable

fun Modifier.zoomable(state: ZoomableState, enabled: Boolean = true, onClick: (Offset) -> Unit? = null, onLongClick: (Offset) -> Unit? = null, clipToBounds: Boolean = true, onDoubleClick: DoubleClickToZoomListener = DoubleClickToZoomListener.ToggleBetweenMinAndMax): Modifier

A Modifier for handling pan & zoom gestures, designed to be shared across all your media composables so that your users can use the same familiar gestures throughout your app. It offers,