lib/com.shambu.compose.scrollbar.foundation/ScrollbarLayout

ScrollbarLayout

class ScrollbarLayout(val layoutDirection: LayoutDirection, val orientation: Orientation, val viewPortLength: Float, val viewPortCrossAxisLength: Float, val contentLength: Float, val contentOffset: Int, val scrollbarAlpha: Float, val density: Float, val fontScale: Float) : Density

Layout configuration of the scrollable container, providing information on the dimensions, orientation, and content offset.

Constructors

ScrollbarLayout

constructor(layoutDirection: LayoutDirection, orientation: Orientation, viewPortLength: Float, viewPortCrossAxisLength: Float, contentLength: Float, contentOffset: Int, scrollbarAlpha: Float, density: Float, fontScale: Float)

Properties

contentLength

val contentLength: Float

The total length of the scrollable content in the primary scroll direction, which may exceed the viewport length if content is scrollable.

contentOffset

val contentOffset: Int

The current offset of the content from the start of the scrollable area, in pixels. Represents how far the content has been scrolled in the primary direction.

density

open override val density: Float

The screen density of the device, used for converting between dp and pixels. Implemented from the Density interface.

fontScale

open override val fontScale: Float

The scale factor for fonts, used to adjust text size based on user preferences. Implemented from the Density interface.

layoutDirection

val layoutDirection: LayoutDirection

The layout direction of the container, specifying whether the content flows left-to-right or right-to-left. See LayoutDirection for available options.

orientation

val orientation: Orientation

The orientation of the scrollable content, which can be either horizontal or vertical. See Orientation for available options.

scrollbarAlpha

val scrollbarAlpha: Float

The opacity of the scrollbar, where 0 is fully transparent and 1 is fully opaque. Used to control the visibility of the scrollbar during interactions.

viewPortCrossAxisLength

val viewPortCrossAxisLength: Float

The length of the viewport along the cross-axis (e.g., width for vertical scrolling, height for horizontal). Useful for determining the scrollbar's cross-axis positioning.

viewPortLength

val viewPortLength: Float

The length of the viewport in the primary scroll direction (e.g., height for vertical scrolling, width for horizontal). This represents the visible area of the content.

Functions

calculateBarLength

fun calculateBarLength(topPadding: Float = 0.0f, startPadding: Float = 0.0f, bottomPadding: Float = 0.0f, endPadding: Float = 0.0f): Float

Calculates the bar (track) length with the given padding

calculateIndicatorLength

fun calculateIndicatorLength(scrollbarLength: Float, minimumIndicatorLength: Float = 24.0f, maximumIndicatorLength: Float = Float.MAX_VALUE): Float

Calculates indicator length required for the given scrollbarLength and contentLength within the given minimumIndicatorLength and maximumIndicatorLength values

calculateIndicatorOffset

fun calculateIndicatorOffset(scrollbarLength: Float, indicatorLength: Float): Float

Calculates the offset position of the scrollbar indicator (thumb) within the scrollbar track. This offset helps to position the indicator correctly based on the scrollbar's and indicator's lengths.

roundToPx