lib/com.shambu.compose.scrollbar.foundation

Package-level declarations

Types

data class BorderStyle(val color: ColorType, val width: Dp, val miter: Dp? = null, val cap: StrokeCap = DefaultCap, val join: StrokeJoin = DefaultJoin, val pathEffect: PathEffect? = null)

BorderStyle provides information for drawing border

ColorType

sealed interface ColorType

Represents a color type. This defines two possible types of colors:

ScrollbarConfig

data class ScrollbarConfig(val indicatorThickness: Dp = 8.dp, val indicatorCornerRadius: Dp = indicatorThickness / 2, val indicatorColor: ColorType = ColorType.Solid(Color.DarkGray.copy(alpha = 0.75f)), val indicatorBorder: BorderStyle = BorderStyle(ColorType.Solid(Color.Transparent), 0.dp), val minimumIndicatorLength: Dp = 24.dp, val maximumIndicatorLength: Dp = Dp.Infinity, val barThickness: Dp = indicatorThickness, val barCornerRadius: Dp = barThickness / 2, val barColor: ColorType = ColorType.Solid(Color.LightGray.copy(alpha = 0.75f)), val barBorder: BorderStyle = BorderStyle(ColorType.Solid(Color.Transparent), 0.dp), val showAlways: Boolean = false, val autoHideAnimationSpec: AnimationSpec<Float>? = null, val padding: PaddingValues = PaddingValues(all = 0.dp), val indicatorPadding: PaddingValues = PaddingValues(all = 0.dp), val isDragEnabled: Boolean = true)

Configuration for customizing the appearance and behavior of a scrollbar.

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.

ScrollbarLayoutScope

interface ScrollbarLayoutScope : Density

A scope, which allows to report the ScrollbarMeasurements and further draw the Scrollbar with the measured values inside the DrawScope.

ScrollbarMeasureAndDraw

typealias ScrollbarMeasureAndDraw = ScrollbarLayoutScope.(layout: ScrollbarLayout) -> ScrollbarMeasurementResult

A function that measures and draws the scrollbar based on the given layout configuration.

ScrollbarMeasurementResult

class ScrollbarMeasurementResult

ScrollbarMeasurements

data class ScrollbarMeasurements(val barBounds: Rect, val indicatorBounds: Rect, val alpha: Float)

ScrollbarSemanticProperties

object ScrollbarSemanticProperties

ScrollbarState

@Stable

class ScrollbarState

State for controlling and managing the scrollbar's properties and activity. This state is responsible for tracking the scrollbar's position, length, and drag activity.

Properties

isTransparent

val ColorType.isTransparent: Boolean

Functions

applyPadding

fun Rect.applyPadding(density: Density, paddingValues: PaddingValues, layoutDirection: LayoutDirection): Rect

rememberScrollbarState

@Composable

fun rememberScrollbarState(): ScrollbarState

Create and remember the ScrollbarState for managing scrollbar interactions and properties within a composable.