[Feature Request] Let rotaryWithScroll support nested scrolling about horologist HOT 3 OPEN

@ichenhe thanks for your feedback and proposal. That request makes total sense. We're working on bringing rotary support by default to Compose for WearOS in AndroidX, so this will be very useful.
What we have to do is to align this api with similar apis regarding nested scroll support.

from horologist.

Cc @Kpeved in case you have thoughts

from horologist.

@Kpeved Here's my basic idea:

To support nested scrolling, we must implement the following:

• Know the scrolling axis that can not be infered from the ScrollableState.
• Have a NestedScrollDispatcher to dispatch the event.

Parameter

A parameter can be introduced to allow developer to specify the scroll axis and to provide their own NestedScrollDispatcher if needed.

data class NestedScrollOptions (
    val axis: NestedScrollAxis,
    val dispatcher: NestedScrollDispatcher = NestedScrollDispatcher()
)

// public api
public fun Modifier.rotaryWithScroll(
    scrollableState: ScrollableState,
    nestedScrollOptions: NestedScrollOptions? = null,
    // others...
)

Dispatch

1. Make RotaryInputNode extend DelegatingNode and register a delegate node: nestedScrollModifierNode(). The NestedScrollConnection here is meaningless so an empty implementation can be used.

   Example

   private class RotaryInputNode(
     var rotaryScrollHandler: RotaryScrollHandler,
     var nestedScrollDispatcher: NestedScrollDispatcher,
   ) : RotaryInputModifierNode, DelegatingNode() {
     init {
         val conn = object : NestedScrollConnection {}
         delegate(nestedScrollModifierNode(conn, dispatcher = nestedScrollDispatcher))
     }
   }

2. Modify the RotaryScrollBehavior to dispatch nested scroll event.

   Example

    // RotaryScrollBehavior
   suspend fun handleEvent(targetValue: Float) {
       scrollAnimation.animateTo() {
           var consumed = dispatcher.dispatchPreScroll(Offset(0f, delta), NestedScrollSource.Wheel).y
           consumed += scrollBy(delta - consumed)
           dispatcher.dispatchPostScroll(
               Offset(0f, consumed),
               Offset(0f, delta - consumed),
               NestedScrollSource.Wheel
           )
       }
   }

from horologist.