Compose Unstyled 2.0 is out! Check the official announcement blog ->
Interface

MultiModalInjectionScope

The receiver scope of the multi-modal input injection lambda from performMultiModalInput.

Source set: Common
sealed interface MultiModalInjectionScope : InjectionScope

The receiver scope of the multi-modal input injection lambda from performMultiModalInput.

MultiModalInjectionScope brings together the receiver scopes of all individual modalities, allowing you to inject gestures that consist of events from different modalities, like touch and mouse. For each modality, there is a function to which you pass a lambda in which you can inject events for that modality: currently, we have touch, mouse and key functions. See their respective docs for more information.

Note that all events generated by the gesture methods are batched together and sent as a whole after performMultiModalInput has executed its code block.

Example of performing a click via touch input followed by drag and drop via mouse input:

Functions

touch

fun touch(block: TouchInjectionScope.() -> Unit)

Injects all touch events sent by the given block

indirectPointer

fun indirectPointer(
        indirectPointerEventPrimaryDirectionalMotionAxis:
            IndirectPointerEventPrimaryDirectionalMotionAxis,
        inputDeviceSize: IntSize,
        block: IndirectPointerInjectionScope.() -> Unit,
    )

Injects all indirect pointer events sent by the given block. This API requires an active focus state meaning developers need to request focus to the component or a child of the component via SemanticsNodeInteraction.requestFocus() before calling this function. If no component is currently focused, the event will not trigger.

Parameters
indirectPointerEventPrimaryDirectionalMotionAxis The main movement axis (horizontal or vertical) for single-directional scrolling when using the touchpad inputDeviceSize. For instance, if the primary axis is set to X, a display prioritizes scrolling its content (for both horizontal and vertical containers) based on the device's X-axis movement. Note that this input axis may not correspond directly to the resulting scrolling axis on the display (e.g., X-axis movement causing vertical scrolling).
inputDeviceSize The dimensions of the external indirect pointer input device that provide the boundaries for indirect input. If you go outside these dimensions, the tests will throw an exception. Note: This is not related to the screen coordinates.
block Block of code/events to execute in indirect scope

mouse

fun mouse(block: MouseInjectionScope.() -> Unit)

Injects all mouse events sent by the given block

key

fun key(block: KeyInjectionScope.() -> Unit)

Injects all key events sent by the given block

rotary

fun rotary(block: RotaryInjectionScope.() -> Unit)

Injects all rotary events sent by the given block

trackpad

fun trackpad(block: TrackpadInjectionScope.() -> Unit)

Injects all trackpad events sent by the given block

Last updated: