affogato-pager-indicator/com.parsuomash.affogato.pager.indicator/HorizontalPagerIndicator

HorizontalPagerIndicator

fun HorizontalPagerIndicator(pagerState: PagerState, modifier: Modifier = Modifier, activeColor: Color = LocalContentColor.current.copy(alpha = LocalContentAlpha.current), inactiveColor: Color = activeColor.copy(ContentAlpha.disabled), indicatorSize: DpSize = DpSize(width = 8.dp, height = 8.dp), spacing: PaddingValues = PaddingValues(horizontal = 4.dp), indicatorShape: Shape = CircleShape, onIndicatorClick: (Int) -> Unit? = null)

A horizontally laid out indicator for a androidx.compose.foundation.pager.HorizontalPager or androidx.compose.foundation.pager.VerticalPager, representing the currently active page and total pages drawn using a Shape.

This element allows the setting of the indicatorShape, which defines how the indicator is visually represented.

Parameters

pagerState

A androidx.compose.foundation.pager.PagerState object of your androidx.compose.foundation.pager.VerticalPager or androidx.compose.foundation.pager.HorizontalPagerto be used to observe the list's state.

modifier

the modifier to apply to this layout.

activeColor

the color of the active Page indicator

inactiveColor

the color of page indicators that are inactive. This defaults to activeColor with the alpha component set to the ContentAlpha.disabled.

indicatorSize

the size of each indicator in DpSize.

spacing

the horizontal spacing between each indicator in PaddingValues.

indicatorShape

the shape representing each indicator. This defaults to CircleShape.

onIndicatorClick

will be called when user clicks on the indicator. Default value is null.