Merge pull request #35 from bnorm/bnorm/teleprompter

Teleprompter

Author: bnorm

README.md

@@ -50,14 +50,6 @@ Snapshot documentation is available at [bnorm.github.io/storyboard/docs/api/late
 [Various examples](examples) are available to demonstrate how to build Storyboards of
 varying levels of complexity and functionality.
 
-### GitHub Pages
-
-Live versions of the example storyboards are available via GitHub Pages.
-To see how publishing is achieved, see the [`pages.yml` workflow](.github/workflows/pages.yml).
-
-* [Basic](https://bnorm.github.io/storyboard/examples/basic)
-* [Interactive](https://bnorm.github.io/storyboard/examples/interactive)
-
 ## Getting Started
 
 Looking for help? Join the discussion in the [KotlinLang Slack](https://kotlinlang.slack.com/archives/C08R5V4EHDH)!

build.gradle.kts

@@ -1,5 +1,4 @@
 import com.vanniktech.maven.publish.MavenPublishBaseExtension
-import com.vanniktech.maven.publish.SonatypeHost
 import org.jetbrains.dokka.gradle.DokkaExtension
 import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
@@ -66,7 +65,6 @@ allprojects {
     plugins.withId("com.vanniktech.maven.publish") {
         apply(plugin = "org.jetbrains.dokka")
         configure<MavenPublishBaseExtension> {
-            publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL, automaticRelease = true)
             signAllPublications()
             pom {
                 description = "Compose Multiplatform library for building presentations."

examples/README.md

@@ -0,0 +1,25 @@
+# Storyboard Examples
+
+Live versions of the example storyboards are available via GitHub Pages.
+To see how publishing is achieved, see the [`pages.yml` workflow](../.github/workflows/pages.yml).
+
+* [Basic](https://bnorm.github.io/storyboard/examples/basic)
+* [Interactive](https://bnorm.github.io/storyboard/examples/interactive)
+
+## [Basic](basic)
+
+Shows the basics of constructing a storyboard.
+The storyboard attempts to be self-describing, including how navigation and state within a Storyboard work.
+
+## [Interactive](interactive)
+
+Storyboards can be interactive.
+They're just Compose UIs at their core!
+This storyboard demonstrates a few different ways a presenter could interact with a storyboard.
+
+## [Teleprompter](teleprompter) (desktop exclusive)
+
+Advanced example of creating a secondary desktop display for a storyboard.
+This "teleprompter" display can render additional content within the storyboard.
+This can help a presenter record important notes about the presentation
+or even help them interact with the storyboard itself.

examples/basic/build.gradle.kts

@@ -1,4 +1,3 @@
-import org.jetbrains.compose.reload.ComposeHotRun
 import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
 
 plugins {
@@ -45,7 +44,3 @@ compose {
     resources.publicResClass = true
     desktop.application.mainClass = "Main_desktopKt"
 }
-
-tasks.withType<ComposeHotRun>().configureEach {
-    mainClass.set("Main_desktopKt")
-}

examples/basic/src/jvmMain/kotlin/main.desktop.kt

@@ -1,13 +1,12 @@
  import androidx.compose.material.MaterialTheme
 import androidx.compose.material.darkColors
 import androidx.compose.ui.window.application
-import dev.bnorm.storyboard.easel.DesktopStoryEasel
+import dev.bnorm.storyboard.easel.DesktopEasel
 
 fun main() {
-    val storyboard = createStoryboard()
     application {
         MaterialTheme(colors = darkColors()) {
-            DesktopStoryEasel(storyboard)
+            DesktopEasel { createStoryboard() }
         }
     }
 }

examples/basic/src/wasmJsMain/kotlin/main.web.kt

@@ -2,7 +2,7 @@ import androidx.compose.material.MaterialTheme
 import androidx.compose.material.darkColors
 import androidx.compose.ui.ExperimentalComposeUiApi
 import androidx.compose.ui.window.CanvasBasedWindow
-import dev.bnorm.storyboard.easel.WebStoryEasel
+import dev.bnorm.storyboard.easel.WebEasel
 import kotlinx.browser.document
 import org.w3c.dom.HTMLCanvasElement
 
@@ -13,7 +13,7 @@ fun main() {
     element.focus() // Focus is required for keyboard navigation.
     CanvasBasedWindow(canvasElementId = element.id, title = storyboard.title) {
         MaterialTheme(colors = darkColors()) {
-            WebStoryEasel(storyboard)
+            WebEasel { storyboard }
         }
     }
 }

examples/interactive/build.gradle.kts

@@ -1,5 +1,3 @@
-import org.gradle.kotlin.dsl.withType
-import org.jetbrains.compose.reload.ComposeHotRun
 import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
 
 plugins {
@@ -57,7 +55,3 @@ compose {
     resources.publicResClass = true
     desktop.application.mainClass = "Main_desktopKt"
 }
-
-tasks.withType<ComposeHotRun>().configureEach {
-    mainClass.set("Main_desktopKt")
-}

examples/interactive/src/commonMain/kotlin/AppScene.kt

@@ -8,14 +8,13 @@ import androidx.compose.material.Divider
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Text
 import androidx.compose.material.darkColors
-import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import dev.bnorm.storyboard.StoryboardBuilder
 import dev.bnorm.storyboard.easel.Story
 import dev.bnorm.storyboard.easel.overlay.OverlayNavigation
-import dev.bnorm.storyboard.easel.overlay.StoryOverlay
-import dev.bnorm.storyboard.easel.rememberStoryState
+import dev.bnorm.storyboard.easel.overlay.StoryOverlayDecorator
+import dev.bnorm.storyboard.easel.rememberEasel
 import dev.bnorm.storyboard.easel.template.Body
 import dev.bnorm.storyboard.easel.template.Header
 import dev.bnorm.storyboard.easel.template.RevealEach
@@ -33,20 +32,19 @@ fun StoryboardBuilder.AppScene() {
                     Modifier.padding(vertical = 16.dp, horizontal = 16.dp),
                     verticalArrangement = Arrangement.spacedBy(16.dp),
                 ) {
-                    val state = rememberStoryState(remember { createStoryboard() })
+                    val easel = rememberEasel { createStoryboard() }
 
                     RevealEach(transition.createChildTransition { it.toState() }) {
                         item { Text("• Storyboard is ultimately just a Compose application.") }
                         item { Text("• Anything achievable with Compose, is possible in Storyboard!") }
                         item { Text("• You could even embed a Storyboard, in a Storyboard!") }
                         item {
                             MaterialTheme(colors = darkColors()) {
-                                StoryOverlay(
-                                    overlay = { OverlayNavigation(state) },
-                                    modifier = Modifier.requiredSize(state.storyboard.format.toDpSize() / 3)
-                                ) {
-                                    Story(state)
-                                }
+                                Story(
+                                    easel,
+                                    decorator = StoryOverlayDecorator(overlay = { OverlayNavigation(easel) }),
+                                    modifier = Modifier.requiredSize(easel.storyboard.format.toDpSize() / 3)
+                                )
                             }
                         }
                     }

examples/interactive/src/jvmMain/kotlin/main.desktop.kt

@@ -2,13 +2,12 @@ import androidx.compose.material.MaterialTheme
 import androidx.compose.material.lightColors
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.window.application
-import dev.bnorm.storyboard.easel.DesktopStoryEasel
+import dev.bnorm.storyboard.easel.DesktopEasel
 
 fun main() {
-    val storyboard = createStoryboard()
     application {
         MaterialTheme(colors = lightColors(background = Color.Gray)) {
-            DesktopStoryEasel(storyboard)
+            DesktopEasel { createStoryboard() }
         }
     }
 }

examples/interactive/src/wasmJsMain/kotlin/main.web.kt

@@ -3,7 +3,7 @@ import androidx.compose.material.lightColors
 import androidx.compose.ui.ExperimentalComposeUiApi
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.window.CanvasBasedWindow
-import dev.bnorm.storyboard.easel.WebStoryEasel
+import dev.bnorm.storyboard.easel.WebEasel
 import kotlinx.browser.document
 import org.w3c.dom.HTMLCanvasElement
 
@@ -14,7 +14,7 @@ fun main() {
     element.focus() // Focus is required for keyboard navigation.
     CanvasBasedWindow(canvasElementId = element.id, title = storyboard.title) {
         MaterialTheme(colors = lightColors(background = Color.Gray)) {
-            WebStoryEasel(storyboard)
+            WebEasel { storyboard }
         }
     }
 }