Storyteller SDK Documentation/com.storyteller.ui.compose.components.lists.grid

Package-level declarations

Types

class StorytellerGridState(val lazyGridState: LazyGridState = LazyGridState(), val enablePullToRefresh: Boolean = false) : StorytellerDataState

A state holder for Storyteller grid components (e.g., StorytellerStoriesGrid, StorytellerClipsGrid). It encapsulates a LazyGridState to manage the underlying grid's scroll position and layout information. It also provides methods to interact with the grid, such as reloading its data or scrolling to specific items, and can manage pull-to-refresh behavior. For more details on using Storyteller list components and their states, see the Storyteller Lists Documentation.

Functions

rememberStorytellerGridState

@Composable

fun rememberStorytellerGridState(key: Any? = null, lazyGridState: LazyGridState = rememberLazyGridState(), enablePullToRefresh: Boolean = false): StorytellerGridState

Remembers a StorytellerGridState instance across recompositions for use with Storyteller grid components. This state holder manages the underlying LazyGridState and pull-to-refresh behavior. For more details on using Storyteller list components and their states, see the Storyteller Lists Documentation.

StorytellerClipsGrid

@Composable

fun StorytellerClipsGrid(modifier: Modifier = Modifier, state: StorytellerGridState = rememberStorytellerGridState(), dataModel: StorytellerClipsDataModel, isScrollable: Boolean, delegate: StorytellerListViewDelegate, searchInput: SearchInput? = null, isEnabled: Boolean = true, isVisible: Boolean = true)

A Composable function that displays a grid of Storyteller Clips. This component is used to render a collection of video Clips in a grid layout. For more details on using Storyteller list components, see the Storyteller Lists Documentation.

StorytellerStoriesGrid

@Composable

fun StorytellerStoriesGrid(modifier: Modifier = Modifier, state: StorytellerGridState = rememberStorytellerGridState(), dataModel: StorytellerStoriesDataModel, isScrollable: Boolean, delegate: StorytellerListViewDelegate, isEnabled: Boolean = true)

A Composable function that displays a grid of Storyteller Stories. This component is used to render Stories, typically from one or more categories, in a grid layout. For more details on using Storyteller list components, see the Storyteller Lists Documentation.