Storyteller SDK Documentation/com.storyteller.ui.home

Package-level declarations

Types

Link copied to clipboard
class StorytellerHomeFragment : Fragment

A Fragment that displays a Storyteller Home screen. The Home screen is a configurable vertical list that can contain various Storyteller list components such as com.storyteller.ui.list.StorytellerStoriesRowView, com.storyteller.ui.list.StorytellerStoriesGridView, com.storyteller.ui.list.StorytellerClipsRowView, and com.storyteller.ui.list.StorytellerClipsGridView, as defined by a "Home" configuration in the CMS.

Link copied to clipboard
class StorytellerHomeState(val lazyListState: LazyListState = LazyListState())

A state holder for the StorytellerHome Composable. It encapsulates a LazyListState to manage the Home screen's overall scroll position and provides a method to reload the data for all items within the Home screen.

Functions

Link copied to clipboard
@Composable
fun rememberStorytellerHomeState(lazyListState: LazyListState = LazyListState()): StorytellerHomeState

Remembers a StorytellerHomeState instance across recompositions for use with the StorytellerHome Composable. This state holder manages the LazyListState for the main vertical list of the Home screen and provides a reloadData function to refresh all content.

Link copied to clipboard
@Composable
fun StorytellerHome(homeId: String, modifier: Modifier = Modifier, theme: UiTheme? = null, context: StorytellerAnalyticsContext? = null, uiStyle: StorytellerListViewStyle = StorytellerListViewStyle.AUTO, state: StorytellerHomeState = rememberStorytellerHomeState())

A Composable function that displays a Storyteller Home screen. The Home screen is a configurable vertical list capable of displaying various Storyteller list components, such as com.storyteller.ui.compose.components.lists.row.StorytellerStoriesRow, com.storyteller.ui.compose.components.lists.grid.StorytellerStoriesGrid, com.storyteller.ui.compose.components.lists.row.StorytellerClipsRow, and com.storyteller.ui.compose.components.lists.grid.StorytellerClipsGrid. The specific layout and content are determined by a "Home" configuration fetched from the Storyteller CMS using the provided homeId. For more information on using the Storyteller Home screen, see the Storyteller Home Screen Documentation.