# androidx.wear.compose.foundation.rotary

This package offers APIs for handling rotary input from hardware components like a rotating side button (RSB) or a physical bezel on Wear OS devices. The primary component is the `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/rotary/rotaryScrollable.modifier#(androidx.compose.ui.Modifier).rotaryScrollable(androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,androidx.compose.ui.focus.FocusRequester,kotlin.Boolean,androidx.compose.foundation.OverscrollEffect)` modifier, which allows you to connect rotary input to scrollable composables.

Scrolling lists such as `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyColumn.composable#ScalingLazyColumn(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.lazy.ScalingLazyListState,androidx.compose.foundation.layout.PaddingValues,kotlin.Boolean,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.ui.Alignment.Horizontal,androidx.compose.foundation.gestures.FlingBehavior,kotlin.Boolean,androidx.wear.compose.foundation.lazy.ScalingParams,androidx.wear.compose.foundation.lazy.ScalingLazyListAnchorType,androidx.wear.compose.foundation.lazy.AutoCenteringParams,androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,androidx.compose.foundation.OverscrollEffect,kotlin.Function1)` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/TransformingLazyColumn.composable#TransformingLazyColumn(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.lazy.TransformingLazyColumnState,androidx.compose.foundation.layout.PaddingValues,kotlin.Boolean,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.ui.Alignment.Horizontal,androidx.compose.foundation.gestures.FlingBehavior,kotlin.Boolean,androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,androidx.compose.foundation.OverscrollEffect,androidx.wear.compose.foundation.lazy.TransformingLazyColumnFirstLayoutItemProvider,kotlin.Function1)` support rotary input by default, as does the `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/pager/VerticalPager.composable#VerticalPager(androidx.wear.compose.foundation.pager.PagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.foundation.gestures.TargetedFlingBehavior,kotlin.Boolean,kotlin.Boolean,kotlin.Function1,androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,kotlin.Function2)`. The `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/rotary/rotaryScrollable.modifier#(androidx.compose.ui.Modifier).rotaryScrollable(androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,androidx.compose.ui.focus.FocusRequester,kotlin.Boolean,androidx.compose.foundation.OverscrollEffect)` modifier is provided so that custom components can be extended for rotary support too.

## Interfaces

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/rotary/RotaryScrollableBehavior` | An interface for handling scroll events. |
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/rotary/RotarySnapLayoutInfoProvider` | A provider which connects scrollableState to a rotary input for snapping scroll actions. |

## Objects

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/rotary/RotaryScrollableDefaults` | Defaults for rotaryScrollable modifier |

## Modifiers

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/rotary/rotaryScrollable.modifier` | A modifier which connects rotary events with scrollable containers such as Column, LazyList and others. |