slideshow/com.zachklipp.richtext.ui.slideshow

Package-level declarations

Types

Link copied to clipboard
interface NavigableContentScope : SlideScope

Receiver type for NavigableContentContainer children.

Link copied to clipboard
typealias NavigationInterceptor = (forward: Boolean) -> Boolean
Link copied to clipboard
interface SlideScope

Receiver for slide composables passed to Slideshow that provides some context about the current slide, as well as functions for controlling navigation.

Link copied to clipboard
Link copied to clipboard
@Immutable
data class SlideshowTheme(val contentColor: Color = Color.White, val backgroundColor: Color = Color.DarkGray, val baseTextStyle: TextStyle = TextStyle(fontSize = 18.sp), val titleStyle: TextStyle = TextStyle( fontSize = 48.sp, textAlign = Center, fontWeight = FontWeight.Bold ), val subtitleStyle: TextStyle = TextStyle( fontSize = 36.sp, textAlign = Center ), val headerStyle: TextStyle = TextStyle(fontSize = 28.sp), val footerStyle: TextStyle = TextStyle(fontSize = 12.sp), val gap: Dp = 16.dp, val aspectRatio: Float = 16 / 9f)

Defines the visual styling for a Slideshow.

Functions

Link copied to clipboard
@Composable
fun SlideScope.BodySlide(header: @Composable () -> Unit, body: @Composable () -> Unit, footer: @Composable () -> Unit = { SlideNumberFooter() })

A composable to define a Slideshow slide which displays a large header at the top of the slide, an optional footer at the bottom, and some content in the middle. All children are start-aligned.

Link copied to clipboard
@Composable
fun SlideScope.NavigableContentContainer(children: @Composable NavigableContentScope.() -> Unit)

Wrapper for Slideshow slides that want to initially display a subset of their content, and eventually reveal more content as the slideshow is advanced. The children of this content receive a NavigableContentScope, which can be used to define pieces of content which should be gradually revealed. Every occurrence of NavigableContentScope.NavigableContent will be initially invoked with visible=false, and then gradually invoked with visible=true as the slideshow is advanced.

Link copied to clipboard
Link copied to clipboard
@Composable
fun SlideScope.SlideDivider()

A simple horizontal divider line which uses the SlideshowTheme content color.

Link copied to clipboard
@Composable
fun SlideScope.SlideNumberFooter()

A text composable which displays the current slide number from the SlideScope, right-aligned in its parent.

Link copied to clipboard
@Composable
fun Slideshow(vararg slides: @Composable SlideScope.() -> Unit, controller: SlideshowController = rememberSlideshowController(), theme: SlideshowTheme = SlideshowTheme())

A slideshow consisting of a sequence of slides which can be navigated through by tapping on them.

Link copied to clipboard
@Composable
fun SlideScope.TitleSlide(title: @Composable () -> Unit, subtitle: @Composable () -> Unit? = null)

A composable to define a Slideshow slide that shows a large, bold title in the center of the slide with an optional subtitle below it.