# OneHandedGestureHorizontalPageIndicator

## Functions summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/OneHandedGestureHorizontalPageIndicator.composable#OneHandedGestureHorizontalPageIndicator(androidx.wear.compose.material3.onehandedgesture.OneHandedGestureConfiguration,androidx.wear.compose.material3.onehandedgesture.OneHandedGesturePageIndicatorState,androidx.wear.compose.foundation.pager.PagerState,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)( gestureConfiguration: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/OneHandedGestureConfiguration, indicatorState: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/OneHandedGesturePageIndicatorState, pagerState: https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/pager/PagerState, modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier, selectedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, unselectedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, backgroundColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, gestureIndicatorTint: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, gestureIndicatorBackgroundColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color )` A horizontal page indicator that can temporarily display a gesture indicator to demonstrate how to navigate between pages using one-handed gestures. |

## Functions

### OneHandedGestureHorizontalPageIndicator

Artifact: [androidx.wear.compose:compose-material3](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material3/onehandedgesture/OneHandedGesturePageIndicator.kt+function:OneHandedGestureHorizontalPageIndicator) Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.7.0)

```
@Composable
fun OneHandedGestureHorizontalPageIndicator(
    gestureConfiguration: OneHandedGestureConfiguration,
    indicatorState: OneHandedGesturePageIndicatorState,
    pagerState: PagerState,
    modifier: Modifier = Modifier,
    selectedColor: Color = PageIndicatorDefaults.selectedColor,
    unselectedColor: Color = PageIndicatorDefaults.unselectedColor,
    backgroundColor: Color = PageIndicatorDefaults.backgroundColor,
    gestureIndicatorTint: Color = OneHandedGestureDefaults.pageIndicatorTint,
    gestureIndicatorBackgroundColor: Color = OneHandedGestureDefaults.pageIndicatorBackgroundColor
): Unit
```

A horizontal page indicator that can temporarily display a gesture indicator to demonstrate how to navigate between pages using one-handed gestures.

This component functions as a standard page indicator, using dots or bars to represent the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/package-summary#OneHandedGestureHorizontalPageIndicator(androidx.wear.compose.material3.onehandedgesture.OneHandedGestureConfiguration,androidx.wear.compose.material3.onehandedgesture.OneHandedGesturePageIndicatorState,androidx.wear.compose.foundation.pager.PagerState,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)`. It also observes the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/OneHandedGesturePageIndicatorState` to manage the visual transition into a gesture indicator. When `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/OneHandedGesturePageIndicatorState#showIndicator()` is called, the indicator temporarily replaces its standard visual state with a gesture animation sequence.

Sample demonstrating a gesture indicator applied to a `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/pager/HorizontalPager.composable#HorizontalPager(androidx.wear.compose.foundation.pager.PagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.foundation.gestures.TargetedFlingBehavior,kotlin.Boolean,androidx.wear.compose.foundation.GestureInclusion,kotlin.Boolean,kotlin.Function1,androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,kotlin.Function2)`:

```kotlin
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import androidx.wear.compose.foundation.pager.HorizontalPager
import androidx.wear.compose.foundation.pager.rememberPagerState
import androidx.wear.compose.material3.AnimatedPage
import androidx.wear.compose.material3.HorizontalPagerScaffold
import androidx.wear.compose.material3.ScreenScaffold
import androidx.wear.compose.material3.Text
import androidx.wear.compose.material3.onehandedgesture.OneHandedGestureAction
import androidx.wear.compose.material3.onehandedgesture.OneHandedGestureDefaults
import androidx.wear.compose.material3.onehandedgesture.OneHandedGestureHorizontalPageIndicator
import androidx.wear.compose.material3.onehandedgesture.OneHandedGesturePageIndicatorState
import androidx.wear.compose.material3.onehandedgesture.oneHandedGesture
import androidx.wear.compose.material3.onehandedgesture.rememberOneHandedGestureConfiguration

val pagerState = rememberPagerState(pageCount = { 10 })
val gestureConfig =
    rememberOneHandedGestureConfiguration(action = OneHandedGestureAction.Primary)
val indicatorState = remember { OneHandedGesturePageIndicatorState() }
val coroutineScope = rememberCoroutineScope()

HorizontalPagerScaffold(
    pagerState = pagerState,
    pageIndicator = {
        OneHandedGestureHorizontalPageIndicator(
            gestureConfiguration = gestureConfig,
            indicatorState = indicatorState,
            pagerState = pagerState,
        )
    },
) {
    HorizontalPager(
        state = pagerState,
        modifier =
            Modifier.oneHandedGesture(
                gestureConfiguration = gestureConfig,
                onGestureLabel = "scroll to the next page",
                onGestureAvailable = {
                    coroutineScope.launch { indicatorState.showIndicator() }
                },
            ) {
                OneHandedGestureDefaults.scrollToNextPage(pagerState)
            },
    ) { page ->
        AnimatedPage(pageIndex = page, pagerState = pagerState) {
            ScreenScaffold { contentPadding ->
                Column(
                    modifier = Modifier.fillMaxSize().padding(contentPadding),
                    horizontalAlignment = Alignment.CenterHorizontally,
                    verticalArrangement = Arrangement.Center,
                ) {
                    Text(text = "Page #$page")
                    Spacer(modifier = Modifier.height(8.dp))
                    Text(text = "Swipe left and right")
                }
            }
        }
    }
}
```

| Parameters |
|---|---|
| `gestureConfiguration: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/OneHandedGestureConfiguration` | the specification for the one-handed gesture |
| `indicatorState: https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/onehandedgesture/OneHandedGesturePageIndicatorState` | The state object used to synchronize the indicator visibility. |
| `pagerState: https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/pager/PagerState` | The state of the `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/pager/HorizontalPager.composable#HorizontalPager(androidx.wear.compose.foundation.pager.PagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.foundation.gestures.TargetedFlingBehavior,kotlin.Boolean,androidx.wear.compose.foundation.GestureInclusion,kotlin.Boolean,kotlin.Function1,androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,kotlin.Function2)` that this indicator represents. |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | Modifier to be applied to the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/HorizontalPageIndicator.composable#HorizontalPageIndicator(androidx.wear.compose.foundation.pager.PagerState,androidx.compose.ui.Modifier,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)` |
| `selectedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = PageIndicatorDefaults.selectedColor` | The color which will be used for a selected indicator item. |
| `unselectedColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = PageIndicatorDefaults.unselectedColor` | The color which will be used for an unselected indicator item. |
| `backgroundColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = PageIndicatorDefaults.backgroundColor` | The color which will be used for an indicator background. |
| `gestureIndicatorTint: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = OneHandedGestureDefaults.pageIndicatorTint` | The color which will be used for a tint of the gesture animation icon. |
| `gestureIndicatorBackgroundColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = OneHandedGestureDefaults.pageIndicatorBackgroundColor` | The color which will be used for a background behind the gesture animation. See also the [UI Design Guides for One-Handed Gestures](https://developer.android.com/design/ui/wear/guides/patterns/gestures) |