storyboard-easel/dev.bnorm.storyboard.easel

Package-level declarations

Types

Animatic

class Animatic : StoryController

EaselWindow

interface EaselWindow

SceneFrame

interface SceneFrame<T>

SceneMode

enum SceneMode : Enum<SceneMode>

What mode for a dev.bnorm.storyboard.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.

StoryController

interface StoryController

Properties

LocalSceneMode

val LocalSceneMode: ProvidableCompositionLocal<SceneMode?>

LocalStoryboard

val LocalStoryboard: ProvidableCompositionLocal<Storyboard?>

Functions

animateEnterExit

context(animatedVisibilityScope: AnimatedVisibilityScope)
fun Modifier.animateEnterExit(enter: EnterTransition = fadeIn(), exit: ExitTransition = fadeOut(), label: String = "animateEnterExit"): Modifier

DesktopEasel

@Composable

fun ApplicationScope.DesktopEasel(storyboard: () -> Storyboard)

@Composable

fun ApplicationScope.DesktopEasel(animatic: Animatic, overlay: @Composable StoryOverlayScope.() -> Unit = { OverlayNavigation(animatic) }, windows: List<EaselWindow> = listOf(rememberAssistantWindow(animatic)))

Easel

@Composable

fun Easel(animatic: Animatic, mode: SceneMode = SceneMode.Story, decorator: Decorator = Decorator.None, modifier: Modifier = Modifier)

@Composable

fun Easel(storyboard: Storyboard, transition: Transition<SceneFrame<*>>, mode: SceneMode = SceneMode.Story, decorator: Decorator = Decorator.None, modifier: Modifier = Modifier)

onStoryNavigation

@Composable

fun Modifier.onStoryNavigation(storyController: StoryController): Modifier

rememberAnimatic

@Composable

fun rememberAnimatic(storyboard: () -> Storyboard): Animatic

rememberEasel

@Composable

fun rememberEasel(window: Window, storyboard: () -> Storyboard): Animatic

rememberSharedContentState

@Composable

context(sharedTransitionScope: SharedTransitionScope)
fun rememberSharedContentState(key: Any): SharedTransitionScope.SharedContentState

rememberWindowState

@Composable

fun rememberWindowState(path: Path, format: StringFormat = Json): WindowState?

@Composable

fun rememberWindowState(fileName: String, format: StringFormat = Json): WindowState?

SceneContent

@Composable

context(_: AnimatedVisibilityScope, _: SharedTransitionScope)
fun <T> SceneContent(scene: Scene<T>, sceneFrame: Transition<SceneFrame<*>>)

SceneGallery

@Composable

fun <T> SceneGallery(scene: Scene<T>, modifier: Modifier = Modifier, format: SceneFormat = SceneFormat.Default, decorator: Decorator = Decorator.None, sceneMode: SceneMode = SceneMode.Preview)

ScenePreview

@Composable

fun ScenePreview(storyboard: Storyboard, index: Storyboard.Index, modifier: Modifier = Modifier, sceneMode: SceneMode = SceneMode.Preview)

@Composable

fun <T> ScenePreview(storyboard: Storyboard, scene: Scene<T>, frame: Frame<T>, modifier: Modifier = Modifier, sceneMode: SceneMode = SceneMode.Preview)

@Composable

fun <T> ScenePreview(scene: Scene<T>, frame: Frame<T>, modifier: Modifier = Modifier, format: SceneFormat = SceneFormat.Default, decorator: Decorator = Decorator.None, sceneMode: SceneMode = SceneMode.Preview)

sharedBounds

context(animatedVisibilityScope: AnimatedVisibilityScope, sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedBounds(sharedContentState: SharedTransitionScope.SharedContentState, enter: EnterTransition = fadeIn(), exit: ExitTransition = fadeOut(), resizeMode: SharedTransitionScope.ResizeMode = ScaleToBounds(ContentScale.FillWidth, Center), placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(animatedVisibilityScope: AnimatedVisibilityScope, sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedBounds(sharedContentState: SharedTransitionScope.SharedContentState, enter: EnterTransition = fadeIn(), exit: ExitTransition = fadeOut(), boundsTransform: BoundsTransform, resizeMode: SharedTransitionScope.ResizeMode = ScaleToBounds(ContentScale.FillWidth, Center), placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedBounds(sharedContentState: SharedTransitionScope.SharedContentState, animatedVisibilityScope: AnimatedVisibilityScope, enter: EnterTransition = fadeIn(), exit: ExitTransition = fadeOut(), resizeMode: SharedTransitionScope.ResizeMode = ScaleToBounds(ContentScale.FillWidth, Center), placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(animatedVisibilityScope: AnimatedVisibilityScope, sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedBounds(sharedContentState: SharedTransitionScope.SharedContentState, enter: EnterTransition = fadeIn(), exit: ExitTransition = fadeOut(), boundsTransform: BoundsTransform, resizeMode: SharedTransitionScope.ResizeMode = ScaleToBounds(ContentScale.FillWidth, Center), placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f, clipInOverlayDuringTransition: SharedTransitionScope.OverlayClip): Modifier

context(sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedBounds(sharedContentState: SharedTransitionScope.SharedContentState, animatedVisibilityScope: AnimatedVisibilityScope, enter: EnterTransition = fadeIn(), exit: ExitTransition = fadeOut(), boundsTransform: BoundsTransform, resizeMode: SharedTransitionScope.ResizeMode = ScaleToBounds(ContentScale.FillWidth, Center), placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedBounds(sharedContentState: SharedTransitionScope.SharedContentState, animatedVisibilityScope: AnimatedVisibilityScope, enter: EnterTransition = fadeIn(), exit: ExitTransition = fadeOut(), boundsTransform: BoundsTransform, resizeMode: SharedTransitionScope.ResizeMode = ScaleToBounds(ContentScale.FillWidth, Center), placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f, clipInOverlayDuringTransition: SharedTransitionScope.OverlayClip): Modifier

sharedElement

context(animatedVisibilityScope: AnimatedVisibilityScope, sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedElement(sharedContentState: SharedTransitionScope.SharedContentState, placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(animatedVisibilityScope: AnimatedVisibilityScope, sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedElement(sharedContentState: SharedTransitionScope.SharedContentState, boundsTransform: BoundsTransform, placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedElement(sharedContentState: SharedTransitionScope.SharedContentState, animatedVisibilityScope: AnimatedVisibilityScope, placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(animatedVisibilityScope: AnimatedVisibilityScope, sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedElement(sharedContentState: SharedTransitionScope.SharedContentState, boundsTransform: BoundsTransform, placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f, clipInOverlayDuringTransition: SharedTransitionScope.OverlayClip): Modifier

context(sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedElement(sharedContentState: SharedTransitionScope.SharedContentState, animatedVisibilityScope: AnimatedVisibilityScope, boundsTransform: BoundsTransform, placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f): Modifier

context(sharedTransitionScope: SharedTransitionScope)
fun Modifier.sharedElement(sharedContentState: SharedTransitionScope.SharedContentState, animatedVisibilityScope: AnimatedVisibilityScope, boundsTransform: BoundsTransform, placeHolderSize: SharedTransitionScope.PlaceHolderSize = contentSize, renderInOverlayDuringTransition: Boolean = true, zIndexInOverlay: Float = 0.0f, clipInOverlayDuringTransition: SharedTransitionScope.OverlayClip): Modifier

StoryGallery

@Composable

fun StoryGallery(storyboard: Storyboard, modifier: Modifier = Modifier, sceneMode: SceneMode = SceneMode.Preview)

@Composable

fun StoryGallery(modifier: Modifier = Modifier, name: String = "Gallery", description: String? = null, format: SceneFormat = SceneFormat.Default, decorator: Decorator = Decorator.None, sceneMode: SceneMode = SceneMode.Preview, block: StoryboardBuilder.() -> Unit)

StoryPreview

@Composable

fun StoryPreview(storyboard: Storyboard, modifier: Modifier = Modifier, sceneMode: SceneMode = SceneMode.Preview)

@Composable

fun StoryPreview(modifier: Modifier = Modifier, name: String = "Preview", description: String? = null, format: SceneFormat = SceneFormat.Default, decorator: Decorator = Decorator.None, sceneMode: SceneMode = SceneMode.Preview, block: StoryboardBuilder.() -> Unit)

WebEasel

@Composable

fun WebEasel(storyboard: () -> Storyboard)

@Composable

fun WebEasel(animatic: Animatic, decorator: Decorator = StoryOverviewDecorator(animatic) + StoryOverlayDecorator { OverlayNavigation(animatic) })