Move content out of easel.template

bnorm · bnorm · commit d38027b9dd35 · 2026-02-26T15:24:11.000-06:00
Most of it is going to storyboard-layout. But some of it is just being removed or moved to the example projects. Fixes #9
diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ repository {
 dependencies {
     implementation("dev.bnorm.storyboard:storyboard:0.1.0-SNAPSHOT")
     implementation("dev.bnorm.storyboard:storyboard-easel:0.1.0-SNAPSHOT")
+    implementation("dev.bnorm.storyboard:storyboard-layout:0.1.0-SNAPSHOT")
     implementation("dev.bnorm.storyboard:storyboard-text:0.1.0-SNAPSHOT")
 }
 ```
diff --git a/examples/basic/build.gradle.kts b/examples/basic/build.gradle.kts
@@ -23,6 +23,7 @@ kotlin {
             dependencies {
                 implementation(project(":storyboard"))
                 implementation(project(":storyboard-easel"))
+                implementation(project(":storyboard-layout"))
                 implementation(project(":storyboard-text"))
 
                 implementation(project(":examples:shared"))
diff --git a/examples/basic/src/commonMain/kotlin/AnimationScene.kt b/examples/basic/src/commonMain/kotlin/AnimationScene.kt
@@ -10,8 +10,11 @@ import androidx.compose.ui.platform.LocalDensity
 import androidx.compose.ui.unit.IntOffset
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
-import dev.bnorm.storyboard.easel.template.*
-import dev.bnorm.storyboard.easel.template.rememberAdvanceDirection
+import dev.bnorm.storyboard.layout.template.enter
+import dev.bnorm.storyboard.layout.template.exit
+import dev.bnorm.storyboard.layout.template.Header
+import dev.bnorm.storyboard.layout.template.SceneEnter
+import dev.bnorm.storyboard.layout.template.SceneExit
 import dev.bnorm.storyboard.toValue
 import kotlin.math.roundToInt
 
diff --git a/examples/basic/src/commonMain/kotlin/CodeScene.kt b/examples/basic/src/commonMain/kotlin/CodeScene.kt
@@ -18,12 +18,12 @@ import androidx.compose.ui.text.buildAnnotatedString
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import dev.bnorm.storyboard.StoryboardBuilder
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
-import dev.bnorm.storyboard.easel.template.SceneEnter
-import dev.bnorm.storyboard.easel.template.SceneExit
 import dev.bnorm.storyboard.example.shared.INTELLIJ_DARK_CODE_STYLE
 import dev.bnorm.storyboard.example.shared.JetBrainsMono
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
+import dev.bnorm.storyboard.layout.template.SceneEnter
+import dev.bnorm.storyboard.layout.template.SceneExit
 import dev.bnorm.storyboard.text.highlight.CodeStyle
 import dev.bnorm.storyboard.text.highlight.Language
 import dev.bnorm.storyboard.text.highlight.highlight
diff --git a/examples/basic/src/commonMain/kotlin/NavigationScene.kt b/examples/basic/src/commonMain/kotlin/NavigationScene.kt
@@ -9,8 +9,8 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
 import dev.bnorm.storyboard.easel.assist.SceneCaption
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toValue
 
 fun StoryboardBuilder.NavigationScene() = scene(
diff --git a/examples/basic/src/commonMain/kotlin/StateScene.kt b/examples/basic/src/commonMain/kotlin/StateScene.kt
@@ -13,8 +13,8 @@ import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.Frame
 import dev.bnorm.storyboard.StoryboardBuilder
 import dev.bnorm.storyboard.easel.assist.SceneCaption
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toValue
 
 class StateSceneState(
diff --git a/examples/basic/src/commonMain/kotlin/rememberAdvanceDirection.kt b/examples/basic/src/commonMain/kotlin/rememberAdvanceDirection.kt
@@ -1,5 +1,3 @@
-package dev.bnorm.storyboard.easel.template
-
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.remember
 import dev.bnorm.storyboard.AdvanceDirection
diff --git a/examples/interactive/build.gradle.kts b/examples/interactive/build.gradle.kts
@@ -24,6 +24,7 @@ kotlin {
             dependencies {
                 implementation(project(":storyboard"))
                 implementation(project(":storyboard-easel"))
+                implementation(project(":storyboard-layout"))
                 implementation(project(":storyboard-text"))
 
                 implementation(project(":examples:shared"))
diff --git a/examples/interactive/src/commonMain/kotlin/AppScene.kt b/examples/interactive/src/commonMain/kotlin/AppScene.kt
@@ -15,9 +15,9 @@ import dev.bnorm.storyboard.easel.Easel
 import dev.bnorm.storyboard.easel.overlay.EaselOverlay
 import dev.bnorm.storyboard.easel.overlay.OverlayNavigation
 import dev.bnorm.storyboard.easel.rememberAnimatic
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
-import dev.bnorm.storyboard.easel.template.RevealEach
+import dev.bnorm.storyboard.layout.template.RevealEach
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toDpSize
 import dev.bnorm.storyboard.toValue
 
diff --git a/examples/interactive/src/commonMain/kotlin/ButtonScene.kt b/examples/interactive/src/commonMain/kotlin/ButtonScene.kt
@@ -16,9 +16,9 @@ import androidx.compose.ui.input.pointer.PointerIcon
 import androidx.compose.ui.input.pointer.pointerHoverIcon
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
-import dev.bnorm.storyboard.easel.template.RevealEach
+import dev.bnorm.storyboard.layout.template.RevealEach
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toValue
 
 @OptIn(ExperimentalTransitionApi::class)
diff --git a/examples/interactive/src/commonMain/kotlin/HttpClientScene.kt b/examples/interactive/src/commonMain/kotlin/HttpClientScene.kt
@@ -8,19 +8,21 @@ import androidx.compose.material.Divider
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Text
 import androidx.compose.material.TextField
+import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableIntStateOf
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
+import dev.bnorm.storyboard.easel.LocalSceneMode
+import dev.bnorm.storyboard.easel.SceneMode
 import dev.bnorm.storyboard.easel.assist.SceneCaption
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
-import dev.bnorm.storyboard.easel.template.RevealEach
-import dev.bnorm.storyboard.easel.template.StoryEffect
 import dev.bnorm.storyboard.example.shared.JetBrainsMono
+import dev.bnorm.storyboard.layout.template.RevealEach
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toValue
 import io.ktor.client.*
 import io.ktor.client.call.*
@@ -55,27 +57,29 @@ fun StoryboardBuilder.HttpClientScene() {
         // Make sure the HTTP call is properly scoped.
         // Running this with LaunchedEffect could cause it to trigger multiple times.
         // The scene could be displayed twice, in both the main story and assistant.
-        // By restricting to a StoryEffect, we make sure it is only launched a single time.
+        // By restricting to a Story SceneMode, we make sure it is only launched a single time.
         //
         // A view-model-like class could also help properly scope this work
         // by using a snapshotFlow on the repository and collecting within
         // a custom CoroutineScope.
         // !!!
-        StoryEffect(repository.text) {
-            error = null
-            delay(300) // Debounce keyboard events.
-            try {
-                val response = client.get("https://api.github.com/repos/${repository.text}")
-                if (response.status.isSuccess()) {
-                    stargazers = response.body<Repository>().stargazers
-                } else {
+        if (LocalSceneMode.current == SceneMode.Story) {
+            LaunchedEffect(repository.text) {
+                error = null
+                delay(300) // Debounce keyboard events.
+                try {
+                    val response = client.get("https://api.github.com/repos/${repository.text}")
+                    if (response.status.isSuccess()) {
+                        stargazers = response.body<Repository>().stargazers
+                    } else {
+                        stargazers = -1
+                        error = "Error retrieving repository information: ${response.status}"
+                    }
+                } catch (e: Throwable) {
+                    if (e is CancellationException) throw e
                     stargazers = -1
-                    error = "Error retrieving repository information: ${response.status}"
+                    error = e.stackTraceToString()
                 }
-            } catch (e: Throwable) {
-                if (e is CancellationException) throw e
-                stargazers = -1
-                error = e.stackTraceToString()
             }
         }
 
diff --git a/examples/interactive/src/commonMain/kotlin/TextFieldScene.kt b/examples/interactive/src/commonMain/kotlin/TextFieldScene.kt
@@ -11,9 +11,9 @@ import androidx.compose.material.TextField
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
-import dev.bnorm.storyboard.easel.template.RevealEach
+import dev.bnorm.storyboard.layout.template.RevealEach
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toValue
 
 @OptIn(ExperimentalTransitionApi::class)
diff --git a/examples/shared/build.gradle.kts b/examples/shared/build.gradle.kts
@@ -23,6 +23,7 @@ kotlin {
             dependencies {
                 implementation(project(":storyboard"))
                 implementation(project(":storyboard-easel"))
+                implementation(project(":storyboard-layout"))
                 implementation(project(":storyboard-text"))
 
                 implementation(compose.material)
diff --git a/examples/teleprompter/build.gradle.kts b/examples/teleprompter/build.gradle.kts
@@ -16,6 +16,7 @@ kotlin {
             dependencies {
                 implementation(project(":storyboard"))
                 implementation(project(":storyboard-easel"))
+                implementation(project(":storyboard-layout"))
                 implementation(project(":storyboard-text"))
 
                 implementation(project(":examples:shared"))
diff --git a/examples/teleprompter/src/jvmMain/kotlin/AnnotationScene.kt b/examples/teleprompter/src/jvmMain/kotlin/AnnotationScene.kt
@@ -4,14 +4,17 @@ import androidx.compose.animation.core.createChildTransition
 import androidx.compose.foundation.BorderStroke
 import androidx.compose.foundation.layout.*
 import androidx.compose.foundation.shape.RoundedCornerShape
-import androidx.compose.material.*
+import androidx.compose.material.Divider
+import androidx.compose.material.MaterialTheme
+import androidx.compose.material.Surface
+import androidx.compose.material.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toValue
 import kotlin.time.Duration.Companion.seconds
 
diff --git a/examples/teleprompter/src/jvmMain/kotlin/InteractiveScene.kt b/examples/teleprompter/src/jvmMain/kotlin/InteractiveScene.kt
@@ -13,8 +13,8 @@ import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
-import dev.bnorm.storyboard.easel.template.Body
-import dev.bnorm.storyboard.easel.template.Header
+import dev.bnorm.storyboard.layout.template.Body
+import dev.bnorm.storyboard.layout.template.Header
 import dev.bnorm.storyboard.toValue
 import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.flow.debounce
diff --git a/examples/teleprompter/src/jvmMain/kotlin/IntroScene.kt b/examples/teleprompter/src/jvmMain/kotlin/IntroScene.kt
@@ -6,7 +6,7 @@ import androidx.compose.material.Text
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import dev.bnorm.storyboard.StoryboardBuilder
-import dev.bnorm.storyboard.easel.template.Header
+import dev.bnorm.storyboard.layout.template.Header
 
 @OptIn(ExperimentalTransitionApi::class)
 fun StoryboardBuilder.IntroScene() {
diff --git a/storyboard-easel/src/commonMain/kotlin/dev/bnorm/storyboard/easel/template/SceneIndexDecorator.kt b/storyboard-easel/src/commonMain/kotlin/dev/bnorm/storyboard/easel/template/SceneIndexDecorator.kt
diff --git a/storyboard-easel/src/commonMain/kotlin/dev/bnorm/storyboard/easel/template/StoryEffect.kt b/storyboard-easel/src/commonMain/kotlin/dev/bnorm/storyboard/easel/template/StoryEffect.kt
diff --git a/storyboard-layout/build.gradle.kts b/storyboard-layout/build.gradle.kts
@@ -20,6 +20,7 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
+                api(project(":storyboard"))
                 implementation(compose.material)
             }
         }
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/Formats.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/Formats.kt
@@ -1,4 +1,4 @@
-package dev.bnorm.storyboard.easel.template
+package dev.bnorm.storyboard.layout
 
 import androidx.compose.ui.unit.Density
 import androidx.compose.ui.unit.IntSize
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/Body.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/Body.kt
@@ -1,4 +1,4 @@
-package dev.bnorm.storyboard.easel.template
+package dev.bnorm.storyboard.layout.template
 
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.BoxScope
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/Header.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/Header.kt
@@ -1,4 +1,4 @@
-package dev.bnorm.storyboard.easel.template
+package dev.bnorm.storyboard.layout.template
 
 import androidx.compose.animation.AnimatedVisibilityScope
 import androidx.compose.animation.SharedTransitionScope
@@ -9,7 +9,6 @@ import androidx.compose.material.MaterialTheme
 import androidx.compose.material.ProvideTextStyle
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
-import dev.bnorm.storyboard.easel.sharedElement
 
 @Composable
 fun Header(modifier: Modifier = Modifier, content: @Composable BoxScope.() -> Unit) {
@@ -23,12 +22,15 @@ fun Header(modifier: Modifier = Modifier, content: @Composable BoxScope.() -> Un
 private object SharedHeaderKey
 
 @Composable
-context(_: AnimatedVisibilityScope, scope: SharedTransitionScope)
+context(animatedVisibilityScope: AnimatedVisibilityScope, sharedTransitionScope: SharedTransitionScope)
 fun SharedHeader(modifier: Modifier = Modifier, content: @Composable BoxScope.() -> Unit) {
-    Header(
-        modifier = modifier.sharedElement(
-            sharedContentState = scope.rememberSharedContentState(SharedHeaderKey),
-        ),
-        content = content
-    )
+    with(sharedTransitionScope) {
+        Header(
+            modifier = modifier.sharedElement(
+                sharedContentState = rememberSharedContentState(SharedHeaderKey),
+                animatedVisibilityScope = animatedVisibilityScope,
+            ),
+            content = content
+        )
+    }
 }
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/RevealBuilder.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/RevealBuilder.kt
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/SceneSection.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/SceneSection.kt
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/Title.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/Title.kt
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/animation.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/animation.kt
diff --git a/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/scene.kt b/storyboard-layout/src/commonMain/kotlin/dev/bnorm/storyboard/layout/template/scene.kt

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ repository {`
`36`	`36`	`dependencies {`
`37`	`37`	`implementation("dev.bnorm.storyboard:storyboard:0.1.0-SNAPSHOT")`
`38`	`38`	`implementation("dev.bnorm.storyboard:storyboard-easel:0.1.0-SNAPSHOT")`
	`39`	`+ implementation("dev.bnorm.storyboard:storyboard-layout:0.1.0-SNAPSHOT")`
`39`	`40`	`implementation("dev.bnorm.storyboard:storyboard-text:0.1.0-SNAPSHOT")`
`40`	`41`	`}`
`41`	`42`	```
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-package dev.bnorm.storyboard.easel.template`
`2`		`-`
`3`	`1`	`import androidx.compose.runtime.Composable`
`4`	`2`	`import androidx.compose.runtime.remember`
`5`	`3`	`import dev.bnorm.storyboard.AdvanceDirection`