Represents the state required to draw a scroll indicator (e.g., a scrollbar), which is typically provided by a scrollable component.
For scrollable components with a large number of items, such as lazy layouts, implementations may need to provide a reasonable heuristic for properties like content size, as calculating the exact value might be computationally expensive or impossible.
The total size of the scrollable content, in pixels.
For a vertical scrollable component, this is the total height of the content. For a horizontal scrollable component, this is the total width of the content.
Implementations should return Int.MAX_VALUE if this value is not yet known.
The size of the visible portion of the scrollable content, in pixels.
For a vertical scrollable component, this is the height of the viewport. For a horizontal scrollable component, this is the width of the viewport.
Implementations should return Int.MAX_VALUE if this value is not yet known.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[],[],null,["ScrollIndicatorState \nArtifact: [androidx.compose.foundation:foundation](/jetpack/androidx/releases/compose-foundation) \n[View Source](https://cs.android.com/search?q=file:androidx/compose/foundation/ScrollIndicator.kt+class:androidx.compose.foundation.ScrollIndicatorState) \nAdded in [1.10.0-alpha02](/jetpack/androidx/releases/compose-foundation#1.10.0-alpha02)\nCommon/AllAndroid/JVM\n - Cmn \n\n ```\n interface ScrollIndicatorState\n ```\n\n*** ** * ** ***\n\nRepresents the state required to draw a scroll indicator (e.g., a scrollbar), which is typically provided by a scrollable component.\n\nFor scrollable components with a large number of items, such as lazy layouts, implementations may need to provide a reasonable heuristic for properties like content size, as calculating the exact value might be computationally expensive or impossible.\n\nSummary \n\n| Public properties |\n|-----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|\n| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [contentSize](/reference/kotlin/androidx/compose/foundation/ScrollIndicatorState#contentSize()) The total size of the scrollable content, in pixels. | Cmn |\n| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [scrollOffset](/reference/kotlin/androidx/compose/foundation/ScrollIndicatorState#scrollOffset()) The current scroll offset of the content from the start, in pixels. | Cmn |\n| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [viewportSize](/reference/kotlin/androidx/compose/foundation/ScrollIndicatorState#viewportSize()) The size of the visible portion of the scrollable content, in pixels. | Cmn |\n\nPublic properties \n\ncontentSize \nCmn \nAdded in [1.10.0-alpha02](/jetpack/androidx/releases/compose-foundation#1.10.0-alpha02) \n\n```\nval contentSize: Int\n```\n\nThe total size of the scrollable content, in pixels.\n\nFor a vertical scrollable component, this is the total height of the content. For a horizontal scrollable component, this is the total width of the content.\n\nImplementations should return [Int.MAX_VALUE](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html) if this value is not yet known. \n\nscrollOffset \nCmn \nAdded in [1.10.0-alpha02](/jetpack/androidx/releases/compose-foundation#1.10.0-alpha02) \n\n```\nval scrollOffset: Int\n```\n\nThe current scroll offset of the content from the start, in pixels.\n\nFor a vertical scrollable component, this is the Y offset. For a horizontal scrollable component, this is the X offset.\n\nImplementations should return [Int.MAX_VALUE](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html) if this value is not yet known. \n\nviewportSize \nCmn \nAdded in [1.10.0-alpha02](/jetpack/androidx/releases/compose-foundation#1.10.0-alpha02) \n\n```\nval viewportSize: Int\n```\n\nThe size of the visible portion of the scrollable content, in pixels.\n\nFor a vertical scrollable component, this is the height of the viewport. For a horizontal scrollable component, this is the width of the viewport.\n\nImplementations should return [Int.MAX_VALUE](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/-companion/-m-a-x_-v-a-l-u-e.html) if this value is not yet known."]]
