uikit/com.sdds.uikit/Carousel

Carousel

open class Carousel @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.sd_carouselStyle, defStyleRes: Int = R.style.Sdds_Components_Carousel) : FrameLayout

Компонент карусели на базе ViewPager2 с кнопками навигации и индикатором страниц.

Карусель предоставляет:

горизонтальную прокрутку элементов;
кнопки «Предыдущий» и «Следующий» (можно отключать и настраивать их расположение);
индикатор страниц в виде точек PaginationDots;
возможность задания отступов между элементами и смещения страниц за пределами экрана.

Parameters

context

контекст, в рамках которого создаётся карусель

attrs

атрибуты, заданные в XML-разметке

defStyleAttr

стиль по умолчанию для применения к этому виджету

defStyleRes

резервный стиль по умолчанию, используемый при отсутствии стиля в теме

Constructors

Carousel

@JvmOverloads

constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.sd_carouselStyle, defStyleRes: Int = R.style.Sdds_Components_Carousel)

Types

Companion

object Companion

Properties

adapter

var adapter: RecyclerView.Adapter<*>?

Адаптер ViewPager2.

contentAlignment

var contentAlignment: Int

Выравнивание контента внутри Carousel

controlsEnabled

var controlsEnabled: Boolean

Включает/выключает кнопки переключения текущего элемента в Carousel

controlsPlacement

var controlsPlacement: Int

Расположение кнопок

currentItem

var currentItem: Int

Текущая страница ViewPager2.

gap

var gap: Int

Отступ между элементами ViewPager2

indicatorEnabled

var indicatorEnabled: Boolean

Включает/выключает индикатор текущего элемента

indicatorPadding

var indicatorPadding: Int

Отступ от индикатора до контента ViewPager2

indicatorVisibleItemCount

var indicatorVisibleItemCount: Int

Изменяет кол-во видимых точек в индикаторе PaginationDots

isUserInputEnabled

var isUserInputEnabled: Boolean

Разрешён ли пользовательский ввод (скролл).

nextButtonPadding

var nextButtonPadding: Int

Отступ от кнопки "Следующий" до контента ViewPager2

offscreenPageLimit

var offscreenPageLimit: Int

Кол-во страниц за пределами "экрана"

orientation

var orientation: Int

Ориентация ViewPager2.

prevButtonPadding

var prevButtonPadding: Int

Отступ от кнопки "Предыдущий" до контента ViewPager2

Functions

addItemDecoration

fun addItemDecoration(decoration: RecyclerView.ItemDecoration)

Устанавливает декоратор элементов Carousel

addOnPageChangeCallback

fun addOnPageChangeCallback(callback: ViewPager2.OnPageChangeCallback)

Регистрирует callback для отслеживания изменений страниц.

addPageTransformer

fun addPageTransformer(transformer: ViewPager2.PageTransformer)

Устанавливает трансформер элементов

removeItemDecoration

fun removeItemDecoration(decoration: RecyclerView.ItemDecoration)

Удаляет декоратор элементов Carousel

removeOnPageChangeCallback

fun removeOnPageChangeCallback(callback: ViewPager2.OnPageChangeCallback)

Удаляет ранее зарегистрированный callback.

removePageTransformer

fun removePageTransformer(transformer: ViewPager2.PageTransformer)

Устанавливает трансформер элементов

setNextButtonIcon

fun setNextButtonIcon(icon: Drawable?)

Устанавливает иконку icon для кнопки "Следующий"

setNextButtonIconRes

fun setNextButtonIconRes(@DrawableRes iconRes: Int)

Устанавливает иконку для кнопки "Следующий" из ресурса iconRes

setOffscreenOffset

fun setOffscreenOffset(offset: Float)

Устанавливает смещение страниц за границами экрана.

fun setOffscreenOffset(offsetProvider: (view: View) -> Float)

Устанавливает смещение страниц за границами экрана. Увеличивая смещение уменьшается ширина страницы. За счет этого можно достичь эффекта одновременного отображения соседних элементов.

setPrevButtonIcon

fun setPrevButtonIcon(icon: Drawable?)

Устанавливает иконку icon для кнопки "Предыдущий"

setPrevButtonIconRes

fun setPrevButtonIconRes(@DrawableRes icon: Int)

Устанавливает иконку для кнопки "Предыдущий" из ресурса iconRes