compose-layout/com.google.android.horologist.compose.rotaryinput

Package-level declarations

Types

class DefaultRotaryHapticHandler(scrollableState: ScrollableState, hapticsChannel: Channel<RotaryHapticsType>, hapticsThresholdPx: Long = 50) : RotaryHapticHandler

Default implementation of RotaryHapticHandler. It handles haptic feedback based on the scrollableState, scrolled pixels and hapticsThresholdPx. Haptic is not fired in this class, instead it's sent to hapticsChannel where it'll performed later.

GenericMotionRotaryInputAccumulator

class GenericMotionRotaryInputAccumulator(context: Context, onValueChange: (change: Float) -> Unit, eventAccumulationThresholdMs: Long = RotaryInputConfigDefaults.DEFAULT_EVENT_ACCUMULATION_THRESHOLD_MS, minValueChangeDistancePx: Float = RotaryInputConfigDefaults.DEFAULT_MIN_VALUE_CHANGE_DISTANCE_PX, rateLimitCoolDownMs: Long = RotaryInputConfigDefaults.DEFAULT_RATE_LIMIT_COOL_DOWN_MS)

Accumulator to trigger callbacks based on MotionEvent from rotary input.

RotaryDefaults

object RotaryDefaults

Defaults for rotary modifiers

RotaryHapticFeedback

interface RotaryHapticFeedback

Interface for Rotary haptic feedback

RotaryHapticHandler

interface RotaryHapticHandler

Handles haptics for rotary usage

RotaryHapticsType

@JvmInline

value class RotaryHapticsType(type: Int)

Rotary haptic types

RotaryInputConfigDefaults

object RotaryInputConfigDefaults

RotaryScrollAdapter

interface RotaryScrollAdapter

An adapter which connects scrollableState to Rotary

RotaryVelocityTracker

class RotaryVelocityTracker

A wrapper around VelocityTracker1D to provide support for rotary input.

ScalingLazyColumnRotaryScrollAdapter

class ScalingLazyColumnRotaryScrollAdapter(val scrollableState: ScalingLazyListState) : RotaryScrollAdapter

An implementation of rotary scroll adapter for ScalingLazyColumn

SnapParameters

class SnapParameters(val snapOffset: Int, val thresholdDivider: Float, val resistanceFactor: Float)

Parameters used for snapping

Functions

onRotaryInputAccumulated

fun Modifier.onRotaryInputAccumulated(eventAccumulationThresholdMs: Long = RotaryInputConfigDefaults.DEFAULT_EVENT_ACCUMULATION_THRESHOLD_MS, minValueChangeDistancePx: Float = RotaryInputConfigDefaults.DEFAULT_MIN_VALUE_CHANGE_DISTANCE_PX, rateLimitCoolDownMs: Long = RotaryInputConfigDefaults.DEFAULT_RATE_LIMIT_COOL_DOWN_MS, isLowRes: Boolean = false, onValueChange: (change: Float) -> Unit): Modifier

Accumulates the scroll distances from RotaryScrollEvent and notifies changes with onValueChange once accumulated value is over the thresholds.

onRotaryInputAccumulatedWithFocus

fun Modifier.onRotaryInputAccumulatedWithFocus(focusRequester: FocusRequester? = null, isLowRes: Boolean = false, onValueChange: (Float) -> Unit): Modifier

A focusable modifier that accumulates the scroll distances from RotaryScrollEvent and notifies changes with onValueChange once accumulated value is over the thresholds.

rememberDefaultRotaryHapticFeedback

@Composable

fun rememberDefaultRotaryHapticFeedback(): RotaryHapticFeedback

rememberDisabledHaptic

@Composable

fun rememberDisabledHaptic(): RotaryHapticHandler

Remember disabled haptics handler

rememberRotaryHapticHandler

@Composable

fun rememberRotaryHapticHandler(scrollableState: ScrollableState, throttleThresholdMs: Long = 30, hapticsThresholdPx: Long = 50, hapticsChannel: Channel<RotaryHapticsType> = rememberHapticChannel(), rotaryHaptics: RotaryHapticFeedback = rememberDefaultRotaryHapticFeedback()): RotaryHapticHandler

Remember rotary haptic handler.

rotaryWithPager

fun Modifier.rotaryWithPager(state: PagerState, focusRequester: FocusRequester): Modifier

rotaryWithScroll

@Composable

fun Modifier.rotaryWithScroll(scrollableState: ScrollableState, focusRequester: FocusRequester = rememberActiveFocusRequester(), flingBehavior: FlingBehavior? = ScrollableDefaults.flingBehavior(), rotaryHaptics: RotaryHapticHandler = rememberRotaryHapticHandler(scrollableState), reverseDirection: Boolean = false): Modifier

A modifier which connects rotary events with scrollable. This modifier supports scroll with fling.

rotaryWithSnap

@Composable

fun Modifier.rotaryWithSnap(rotaryScrollAdapter: RotaryScrollAdapter, focusRequester: FocusRequester = rememberActiveFocusRequester(), snapParameters: SnapParameters = RotaryDefaults.snapParametersDefault, rotaryHaptics: RotaryHapticHandler = rememberRotaryHapticHandler(rotaryScrollAdapter.scrollableState), reverseDirection: Boolean = false): Modifier

A modifier which connects rotary events with scrollable. This modifier supports snap.

toRotaryScrollAdapter

@Composable

fun ScalingLazyListState.toRotaryScrollAdapter(): RotaryScrollAdapter

An extension function for creating RotaryScrollAdapter from ScalingLazyListState