---
title: "PagerState"
description: "Creates a default [PagerState] to be used with a [Pager]

Please refer to the sample to learn how to use this API."
type: "function"
---

<div class='type'>Function</div>


<a id='references'></a>
<div class='sourceset sourceset-common'>Common</div>


```kotlin
fun PagerState(
    currentPage: Int = 0,
    @FloatRange(from = -0.5, to = 0.5) currentPageOffsetFraction: Float = 0f,
    pageCount: () -> Int,
): PagerState
```


Creates a default `PagerState` to be used with a `Pager`

Please refer to the sample to learn how to use this API.

#### Parameters

| | |
| --- | --- |
| currentPage | The pager that should be shown first. |
| currentPageOffsetFraction | The offset of the initial page as a fraction of the page size. This should vary between -0.5 and 0.5 and indicates how to offset the initial page from the snapped position. |
| pageCount | The amount of pages this Pager will have. |




## Code Examples
### PagerWithStateSample
```kotlin
@Composable
fun PagerWithStateSample() {
    // You can use PagerState to define an initial page
    val state = rememberPagerState(initialPage = 5) { 10 }
    HorizontalPager(modifier = Modifier.fillMaxSize(), state = state) { page ->
        Box(
            modifier =
                Modifier.padding(10.dp).background(Color.Blue).fillMaxWidth().aspectRatio(1f),
            contentAlignment = Alignment.Center,
        ) {
            Text(text = page.toString(), fontSize = 32.sp)
        }
    }
}
```