SlideScope

interface SlideScope

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

Inheritors

Functions

Link copied to clipboard
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

Register a callback to be invoked when navigation is requested from this slide. If the callback returns true, the slideshow will not navigate. If it returns false, the next interceptor will have a chance to handle it, or if there are no other interceptors then the slideshow will navigate between slides.

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard
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.

Properties

Link copied to clipboard

If true, this slide was shown via forward navigation, coming from the previous slide.

Link copied to clipboard
abstract val slideNumber: Int

The index of the current slide in the slideshow.