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

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.

Parameters

modifier

The Modifier to be applied to this layout.

state

The StorytellerGridState for managing the state of this grid, such as scroll position and pull-to-refresh. Defaults to a new state remembered by rememberStorytellerGridState.

dataModel

The StorytellerStoriesDataModel which defines the categories of Stories to be displayed and configures aspects like cell type and display limit.

isScrollable

A boolean indicating whether the grid should be scrollable. If set to false, the grid will display a fixed number of items and will not scroll.

delegate

A StorytellerListViewDelegate to handle user interactions and other events within the grid, such as item clicks or data loading states.

isEnabled

A boolean indicating whether this component and its interactions are enabled. Defaults to true. When false, user interactions like clicks might be disabled.