Source for Android/com.gu.source.components.pager/PagerProgressIndicator

PagerProgressIndicator

@Composable
fun PagerProgressIndicator(pagerState: PagerState, selectedIndicatorColour: Color, unSelectedIndicatorColour: Color, modifier: Modifier = Modifier, maxIndicatorCount: Int = DefaultIndicatorCount, indicatorSpacing: Dp = DefaultItemSpacing, indicatorShape: Shape = CircleShape, selectedItemSize: Dp = DefaultSelectedItemSize, unselectedItemScaleFactor: Float = DefaultUnselectedItemScaling, numberOfItemsToScale: Int = DefaultNumberOfItemsToScale, itemsVerticalAlignment: Alignment.Vertical = Alignment.CenterVertically)

A pager progress indicator that displays progress indicators to represent progress in a HorizontalPager or a VerticalPager.

To turn off item scaling, set unselectedItemScaleFactor to 1f.

Parameters

pagerState

The PagerState that this indicator should be bound to.

selectedIndicatorColour

The colour to use for the selected page indicator.

unSelectedIndicatorColour

The colour to use for the unselected page indicator.

modifier

The modifier to apply to the layout.

maxIndicatorCount

The maximum number of indicators to display. The maximum is constrained to the number of pages in the PagerState. The count will be scaled down to the next lower odd number if its even.

indicatorSpacing

Horizontal spacing between indicator. Defaults to DefaultItemSpacing.

indicatorShape

The shape to use for the indicator. Defaults to CircleShape.

selectedItemSize

The size of each item. Defaults to DefaultSelectedItemSize.

unselectedItemScaleFactor

The scaling factor for unselected items as a ratio of the selectedItemSize. Set this to 1F to disable scaling.

numberOfItemsToScale

The number of items to scale in size. This will be scaled down to the next lower odd number if its even.

itemsVerticalAlignment

The vertical alignment to use for the items. Defaults to Alignment.CenterVertically.