# GlimmerHorizontalPagerDefaults

Artifact: [androidx.xr.glimmer:glimmer](https://developer.android.com/jetpack/androidx/releases/xr-glimmer) [View Source](https://cs.android.com/search?q=file:androidx/xr/glimmer/pager/GlimmerPager.kt+class:androidx.xr.glimmer.pager.GlimmerHorizontalPagerDefaults) Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/xr-glimmer#1.0.0-alpha22)


```
object GlimmerHorizontalPagerDefaults
```

<br />

*** ** * ** ***

Default values and helper methods to be used with the `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPager.composable#GlimmerHorizontalPager(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.ui.unit.Dp,androidx.compose.ui.Alignment.Vertical,kotlin.Boolean,kotlin.Boolean,kotlin.Function1,kotlin.Function0,kotlin.Function2)`.

## Summary

| ### Public functions |
|---|---|
| `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/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#PageIndicator(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.Modifier)(state: https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerPagerState, modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier)` A page indicator for a `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPager.composable#GlimmerHorizontalPager(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.ui.unit.Dp,androidx.compose.ui.Alignment.Vertical,kotlin.Boolean,kotlin.Boolean,kotlin.Function1,kotlin.Function0,kotlin.Function2)`, representing the currently active page and total pages using a dot-based visual style |
| `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/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#PageIndicator(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.Modifier)( state: https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerPagerState, selectedIndicatorColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, unselectedIndicatorColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier )` A page indicator for a `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPager.composable#GlimmerHorizontalPager(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.ui.unit.Dp,androidx.compose.ui.Alignment.Vertical,kotlin.Boolean,kotlin.Boolean,kotlin.Function1,kotlin.Function0,kotlin.Function2)`, representing the currently active page and total pages using a dot-based visual style |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#UnselectedIndicatorAlpha()` The alpha that is applied to the selected page indicator dot color, to color the remaining (unselected) page indicator dots |

## Public functions

### PageIndicator

Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/xr-glimmer#1.0.0-alpha22)

```
@Composable
fun PageIndicator(state: GlimmerPagerState, modifier: Modifier = Modifier): Unit
```

A page indicator for a `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPager.composable#GlimmerHorizontalPager(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.ui.unit.Dp,androidx.compose.ui.Alignment.Vertical,kotlin.Boolean,kotlin.Boolean,kotlin.Function1,kotlin.Function0,kotlin.Function2)`, representing the currently active page and total pages using a dot-based visual style

The color of the dot indicating the currently selected page is extracted by retrieving the content color from the nearest `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/surface.composable#(androidx.compose.ui.Modifier).surface(kotlin.Boolean,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.xr.glimmer.SurfaceDepthEffect,androidx.compose.foundation.interaction.InteractionSource)`, while the remaining dots are the content color with an alpha of `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#UnselectedIndicatorAlpha()` applied. To provide custom colors, see the overload of `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#PageIndicator(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.Modifier)` with additional color parameters

| Parameters |
|---|---|
| `state: https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerPagerState` | state object to be used to observe the Pager's state |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | modifier to be applied to the page indicator |

### PageIndicator

Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/xr-glimmer#1.0.0-alpha22)

```
@Composable
fun PageIndicator(
    state: GlimmerPagerState,
    selectedIndicatorColor: Color,
    unselectedIndicatorColor: Color,
    modifier: Modifier = Modifier
): Unit
```

A page indicator for a `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPager.composable#GlimmerHorizontalPager(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.Modifier,androidx.compose.foundation.layout.PaddingValues,kotlin.Int,androidx.compose.ui.unit.Dp,androidx.compose.ui.Alignment.Vertical,kotlin.Boolean,kotlin.Boolean,kotlin.Function1,kotlin.Function0,kotlin.Function2)`, representing the currently active page and total pages using a dot-based visual style

This version of the indicator supports passing in a `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#PageIndicator(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.Modifier)` to color the dot representing the currently selected page, while the remaining dots are colored with `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#PageIndicator(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.Modifier)`

| Parameters |
|---|---|
| `state: https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerPagerState` | state object to be used to observe the Pager's state |
| `selectedIndicatorColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color of the selected page indicator dot |
| `unselectedIndicatorColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | color of the unselected page indicator dots. This value should typically be the `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#PageIndicator(androidx.xr.glimmer.pager.GlimmerPagerState,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.Modifier)` with the alpha `https://developer.android.com/reference/kotlin/androidx/xr/glimmer/pager/GlimmerHorizontalPagerDefaults#UnselectedIndicatorAlpha()` applied |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | modifier to be applied to the page indicator |

## Public properties

### UnselectedIndicatorAlpha

Added in [1.0.0-alpha22](https://developer.android.com/jetpack/androidx/releases/xr-glimmer#1.0.0-alpha22)

```
val UnselectedIndicatorAlpha: Float
```

The alpha that is applied to the selected page indicator dot color, to color the remaining (unselected) page indicator dots