StorytellerRowState

class StorytellerRowState(val lazyListState: LazyListState = LazyListState()) : StorytellerDataState

A state holder for Storyteller row components (e.g., StorytellerStoriesRow, StorytellerClipsRow). It encapsulates a LazyListState to manage the underlying list's scroll position and layout information. It also provides methods to interact with the row, such as reloading its data or scrolling to specific items. For more details on using Storyteller list components and their states, see the Storyteller Lists Documentation.

This state is typically created and remembered using rememberStorytellerRowState.

Parameters

lazyListState

The underlying LazyListState that this state object will manage, Defaults to a new state created by rememberLazyListState.

Constructors

Link copied to clipboard
constructor(lazyListState: LazyListState = LazyListState())

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val isScrolling: Boolean

true if the row is currently being scrolled, false otherwise. Reflects the LazyListState.isScrollInProgress property of the underlying list state.

Link copied to clipboard
Link copied to clipboard

Provides information about the currently visible items and layout of the row. This is a direct accessor to LazyListState.layoutInfo.

Functions

Link copied to clipboard
open suspend override fun reloadData()

Reloads the data for the Storyteller row. This function will first scroll the row to the beginning (index 0, offset 0). See the Storyteller Lists Documentation for more on list management.

Link copied to clipboard
open suspend override fun scrollToItem(index: Int, offset: Int)

Scrolls the row to the item at the specified index with a given pixel offset.