compose-layout/com.google.android.horologist.compose.layout.m3/HeaderInfo

HeaderInfo

class HeaderInfo(val index: Int, val value: String, val inlineContent: Map<String, InlineTextContent> = mapOf(), val extraScrollToOffset: Int? = null)

Class for storing the index and value of a header used for the FastScrollingTransformingLazyColumn. This is used to properly display and snap to the specified header during fast scrolling.

Constructors

HeaderInfo

constructor(index: Int, value: String, inlineContent: Map<String, InlineTextContent> = mapOf(), extraScrollToOffset: Int? = null)

Properties

extraScrollToOffset

val extraScrollToOffset: Int? = null

The optional extra offset added to the default offset.

index

val index: Int

The index of the header in the list.

inlineContent

val inlineContent: Map<String, InlineTextContent>

The optional inline content to be used in the header's text. The string key for this would be dependant on the user, but will be added within the appendInlineContent function when building an annotated string (see https://developer.android.com/reference/kotlin/androidx/compose/ui/text/AnnotatedString for more information).

value

val value: String

The value of the header's text in the list.