storyboard/dev.bnorm.storyboard

Package-level declarations

Types

AdvanceDirection

enum AdvanceDirection : Enum<AdvanceDirection>

Frame

sealed class Frame<out T>

Scene

@Immutable

class Scene<T> : Comparable<Scene<*>>

SceneContent

fun interface SceneContent<T>

SceneDecorator

fun interface SceneDecorator

SceneFormat

class SceneFormat(val size: IntSize, val density: Density)

SceneMode

enum SceneMode : Enum<SceneMode>

What mode for a Scene is active. Scenes can be displayed multiple times and in multiple locations. It is useful for a scene to know what mode it is in, so it can change how it is rendered or perform different effects. For example, a scene may have an animation, which is not useful to play when the scene is being previewed.

SceneScope

@Stable

interface SceneScope<T>

Storyboard

@Stable

class Storyboard

StoryboardBuilder

sealed interface StoryboardBuilder

Properties

DefaultEnterTransition

val DefaultEnterTransition: (AdvanceDirection) -> EnterTransition

DefaultExitTransition

val DefaultExitTransition: (AdvanceDirection) -> ExitTransition

LocalSceneMode

val LocalSceneMode: ProvidableCompositionLocal<SceneMode?>

LocalStoryboard

val LocalStoryboard: ProvidableCompositionLocal<Storyboard?>

Functions

compareTo

operator fun <T : Comparable<T>> Frame<T>.compareTo(other: Frame<T>): Int

decorated

fun <T> SceneContent<T>.decorated(decorator: SceneDecorator): SceneContent<T>

fun StoryboardBuilder.decorated(decorator: SceneDecorator, block: StoryboardBuilder.() -> Unit)

map

fun <T, R> Frame<T>.map(transform: (T) -> R): Frame<R>

plus

operator fun SceneDecorator.plus(other: SceneDecorator): SceneDecorator

Render

fun <T> SceneScope<T>.Render(content: SceneContent<T>)

scene

fun <T> StoryboardBuilder.scene(vararg states: T, enterTransition: (AdvanceDirection) -> EnterTransition = DefaultEnterTransition, exitTransition: (AdvanceDirection) -> ExitTransition = DefaultExitTransition, content: SceneContent<T>): Scene<T>

sceneForBoolean

fun StoryboardBuilder.sceneForBoolean(enterTransition: (AdvanceDirection) -> EnterTransition = DefaultEnterTransition, exitTransition: (AdvanceDirection) -> ExitTransition = DefaultExitTransition, content: SceneContent<Boolean>): Scene<Boolean>

sceneForEnum

inline fun <T : Enum<T>> StoryboardBuilder.sceneForEnum(noinline enterTransition: (AdvanceDirection) -> EnterTransition = DefaultEnterTransition, noinline exitTransition: (AdvanceDirection) -> ExitTransition = DefaultExitTransition, content: SceneContent<T>): Scene<T>

sceneForTransition

fun StoryboardBuilder.sceneForTransition(enterTransition: (AdvanceDirection) -> EnterTransition = DefaultEnterTransition, exitTransition: (AdvanceDirection) -> ExitTransition = DefaultExitTransition, content: SceneContent<Nothing>): Scene<Nothing>

toDpSize

fun SceneFormat.toDpSize(): DpSize

toState

fun <T, R : T> Frame<R>.toState(start: T = when { sceneScope.states.isNotEmpty() -> sceneScope.states.first() else -> error("implicit conversion to state requires non-empty states") }, end: T = when { sceneScope.states.isNotEmpty() -> sceneScope.states.last() else -> error("implicit conversion to state requires non-empty states") }): T

fun <T> Frame<T>.toState(start: T, end: T): T

Converts the Frame of type T to just a value of type T; where start is the default representation for Frame.Start, and end is the default representation for Frame.End.