Package 

Class PagerIndicatorKt

    • Method Summary

      Modifier and Type Method Description
      final static Unit HorizontalPagerIndicator(PagerState pagerState, Modifier modifier, Integer pageCount, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorWidth, Dp indicatorHeight, Dp spacing, Shape indicatorShape) A horizontally laid out indicator for a HorizontalPager or VerticalPager, representing the currently active page and total pages drawn using a Shape.
      final static Unit HorizontalPagerIndicator(PagerState pagerState, Integer pageCount, Modifier modifier, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorWidth, Dp indicatorHeight, Dp spacing, Shape indicatorShape) A horizontally laid out indicator for a androidx.compose.foundation.pager.
      final static Unit VerticalPagerIndicator(PagerState pagerState, Modifier modifier, Integer pageCount, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorHeight, Dp indicatorWidth, Dp spacing, Shape indicatorShape) A vertically laid out indicator for a VerticalPager or HorizontalPager, representing the currently active page and total pages drawn using a Shape.
      final static Unit VerticalPagerIndicator(PagerState pagerState, Integer pageCount, Modifier modifier, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorHeight, Dp indicatorWidth, Dp spacing, Shape indicatorShape) A vertically laid out indicator for a androidx.compose.foundation.pager.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • HorizontalPagerIndicator

         final static Unit HorizontalPagerIndicator(PagerState pagerState, Modifier modifier, Integer pageCount, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorWidth, Dp indicatorHeight, Dp spacing, Shape indicatorShape)

        A horizontally laid out indicator for a HorizontalPager or 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 - the state object of your pager to be used to observe the list's state.
        modifier - the modifier to apply to this layout.
        pageCount - the size of indicators should be displayed, defaults to PagerState.pageCount.
        pageIndexMapping - describe how to get the position of active indicator by the giving page from PagerState.currentPage, if pageCount is not equals to PagerState.pageCount.
        activeColor - the color of the active Page indicator
        inactiveColor - the color of page indicators that are inactive.
        indicatorWidth - the width of each indicator in Dp.
        indicatorHeight - the height of each indicator in Dp.
        spacing - the spacing between each indicator in Dp.
        indicatorShape - the shape representing each indicator.

      • HorizontalPagerIndicator

         final static Unit HorizontalPagerIndicator(PagerState pagerState, Integer pageCount, Modifier modifier, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorWidth, Dp indicatorHeight, Dp spacing, Shape indicatorShape)

        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.
        pageCount - the size of indicators should be displayed.
        modifier - the modifier to apply to this layout.
        pageIndexMapping - describe how to get the position of active indicator by the giving page from androidx.compose.foundation.pager.PagerState.currentPage.
        activeColor - the color of the active Page indicator
        inactiveColor - the color of page indicators that are inactive.
        indicatorWidth - the width of each indicator in Dp.
        indicatorHeight - the height of each indicator in Dp.
        spacing - the spacing between each indicator in Dp.
        indicatorShape - the shape representing each indicator.

      • VerticalPagerIndicator

         final static Unit VerticalPagerIndicator(PagerState pagerState, Modifier modifier, Integer pageCount, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorHeight, Dp indicatorWidth, Dp spacing, Shape indicatorShape)

        A vertically laid out indicator for a VerticalPager or HorizontalPager, 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 - the state object of your pager to be used to observe the list's state.
        modifier - the modifier to apply to this layout.
        pageCount - the size of indicators should be displayed, defaults to PagerState.pageCount.
        pageIndexMapping - describe how to get the position of active indicator by the giving page from PagerState.currentPage, if pageCount is not equals to PagerState.pageCount.
        activeColor - the color of the active Page indicator
        inactiveColor - the color of page indicators that are inactive.
        indicatorHeight - the height of each indicator in Dp.
        indicatorWidth - the width of each indicator in Dp.
        spacing - the spacing between each indicator in Dp.
        indicatorShape - the shape representing each indicator.

      • VerticalPagerIndicator

         final static Unit VerticalPagerIndicator(PagerState pagerState, Integer pageCount, Modifier modifier, Function1<Integer, Integer> pageIndexMapping, Color activeColor, Color inactiveColor, Dp indicatorHeight, Dp indicatorWidth, Dp spacing, Shape indicatorShape)

        A vertically laid out indicator for a androidx.compose.foundation.pager.VerticalPager or androidx.compose.foundation.pager.HorizontalPager, 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.
        pageCount - the size of indicators should be displayed.
        modifier - the modifier to apply to this layout.
        pageIndexMapping - describe how to get the position of active indicator by the giving page from androidx.compose.foundation.pager.PagerState.currentPage.
        activeColor - the color of the active Page indicator
        inactiveColor - the color of page indicators that are inactive.
        indicatorHeight - the height of each indicator in Dp.
        indicatorWidth - the width of each indicator in Dp.
        spacing - the spacing between each indicator in Dp.
        indicatorShape - the shape representing each indicator.