Storyteller SDK Documentation/com.storyteller.ui.compose.components.cards

Package-level declarations

Types

data class StorytellerCardDataModel(val collectionId: String, val context: StorytellerAnalyticsContext? = null)

Data model for displaying a Storyteller Card from a specific Card Collection. For more details on configuring Storyteller Cards, see the Cards Documentation.

StorytellerCardState

class StorytellerCardState

A state holder for Storyteller Card components (StorytellerCard). It manages the reload state and provides methods to interact with the card, such as reloading its data. For more details on using Storyteller Card components and their states, see the Cards Documentation.

StorytellerCardViewDelegate

interface StorytellerCardViewDelegate

An interface for receiving callbacks related to data loading events from Storyteller Card components. Implement this interface to respond to data loading events in your application when using StorytellerCard. For more information on using Storyteller delegates, see the Storyteller Delegates Documentation.

Functions

rememberStorytellerCardState

@Composable

fun rememberStorytellerCardState(key: Any? = null): StorytellerCardState

Remembers a StorytellerCardState instance across recompositions for use with Storyteller Card components. This state holder manages the reload state and provides methods for reloading card data. For more details on using Storyteller Card components and their states, see the Cards Documentation.

StorytellerCard

@Composable

fun StorytellerCard(dataModel: StorytellerCardDataModel, modifier: Modifier = Modifier, state: StorytellerCardState = rememberStorytellerCardState(dataModel.collectionId), delegate: StorytellerCardViewDelegate? = null)

A Composable function that displays a single Storyteller Card. Cards are individual, themeable sections that can be displayed in various aspect ratios (1:1, 2:3, 4:5, 9:16, 16:9, 4:1). Tapping a Card triggers actions such as opening Stories, Clips, Story Categories, Clip Collections, or Custom Links. Cards can feature background images or videos with optional titles and subtitles. For more details on using Storyteller Cards, see the Cards Documentation.