Add fragment behaviors

iamgio · Jul 18, 2024 · 28e608b · 28e608b
1 parent 591ac3b
commit 28e608b
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 2 deletions.
diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/ast/quarkdown/SlidesFragment.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/ast/quarkdown/SlidesFragment.kt
@@ -2,15 +2,47 @@ package eu.iamgio.quarkdown.ast.quarkdown
 
 import eu.iamgio.quarkdown.ast.NestableNode
 import eu.iamgio.quarkdown.ast.Node
+import eu.iamgio.quarkdown.rendering.representable.RenderRepresentable
+import eu.iamgio.quarkdown.rendering.representable.RenderRepresentableVisitor
 import eu.iamgio.quarkdown.visitor.node.NodeVisitor
 
 /**
  * A node that, when rendered in a `Slides` environment,
  * is displayed when the user attempts to go to the next slide.
  * Multiple fragments in the same slide are shown in order on distinct user interactions.
+ * @param behavior visibility type of the fragment and how it reacts to user interactions
  */
 data class SlidesFragment(
+    val behavior: Behavior,
     override val children: List<Node>,
 ) : NestableNode {
     override fun <T> accept(visitor: NodeVisitor<T>): T = visitor.visit(this)
+
+    /**
+     * Possible visibility types of a [SlidesFragment].
+     */
+    enum class Behavior : RenderRepresentable {
+        /**
+         * Starts invisible, fades in on interaction.
+         */
+        SHOW,
+
+        /**
+         * Starts visible, fade out on interaction.
+         */
+        HIDE,
+
+        /**
+         * Starts visible, fade out to 50% on interaction.
+         */
+        SEMI_HIDE,
+
+        /**
+         * Starts invisible, fades in on interaction, then out on the next interaction.
+         */
+        SHOW_HIDE,
+        ;
+
+        override fun <T> accept(visitor: RenderRepresentableVisitor<T>): T = visitor.visit(this)
+    }
 }
diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/rendering/html/CssRepresentableVisitor.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/rendering/html/CssRepresentableVisitor.kt
@@ -1,6 +1,7 @@
 package eu.iamgio.quarkdown.rendering.html
 
 import eu.iamgio.quarkdown.ast.quarkdown.Clipped
+import eu.iamgio.quarkdown.ast.quarkdown.SlidesFragment
 import eu.iamgio.quarkdown.ast.quarkdown.Stacked
 import eu.iamgio.quarkdown.ast.quarkdown.TextTransformData
 import eu.iamgio.quarkdown.document.page.PageMarginPosition
@@ -52,6 +53,14 @@ class CssRepresentableVisitor : RenderRepresentableVisitor<String> {
 
     override fun visit(speed: Transition.Speed) = speed.kebabCaseName
 
+    override fun visit(behavior: SlidesFragment.Behavior) =
+        when (behavior) {
+            SlidesFragment.Behavior.SHOW -> "fade-in"
+            SlidesFragment.Behavior.HIDE -> "fade-out"
+            SlidesFragment.Behavior.SEMI_HIDE -> "semi-fade-out"
+            SlidesFragment.Behavior.SHOW_HIDE -> "fade-in-then-out"
+        }
+
     override fun visit(size: TextTransformData.Size) =
         when (size) {
             TextTransformData.Size.TINY -> "0.5em"

diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/rendering/html/QuarkdownHtmlNodeRenderer.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/rendering/html/QuarkdownHtmlNodeRenderer.kt
@@ -131,7 +131,7 @@ class QuarkdownHtmlNodeRenderer(context: Context) : BaseHtmlNodeRenderer(context
 
     override fun visit(node: SlidesFragment): CharSequence =
         tagBuilder("p", node.children)
-            .attribute("class", "fragment")
+            .attribute("class", "fragment ${node.behavior.asCSS}")
             .build()
 
     override fun visit(node: TextTransform) =

diff --git a/...src/main/kotlin/eu/iamgio/quarkdown/rendering/representable/RenderRepresentableVisitor.kt b/...src/main/kotlin/eu/iamgio/quarkdown/rendering/representable/RenderRepresentableVisitor.kt
@@ -1,6 +1,7 @@
 package eu.iamgio.quarkdown.rendering.representable
 
 import eu.iamgio.quarkdown.ast.quarkdown.Clipped
+import eu.iamgio.quarkdown.ast.quarkdown.SlidesFragment
 import eu.iamgio.quarkdown.ast.quarkdown.Stacked
 import eu.iamgio.quarkdown.ast.quarkdown.TextTransformData
 import eu.iamgio.quarkdown.document.page.PageMarginPosition
@@ -35,6 +36,8 @@ interface RenderRepresentableVisitor<T> {
 
     fun visit(speed: Transition.Speed): T
 
+    fun visit(behavior: SlidesFragment.Behavior): T
+
     fun visit(size: TextTransformData.Size): T
 
     fun visit(weight: TextTransformData.Weight): T

diff --git a/stdlib/src/main/kotlin/eu/iamgio/quarkdown/stdlib/Slides.kt b/stdlib/src/main/kotlin/eu/iamgio/quarkdown/stdlib/Slides.kt
@@ -43,7 +43,11 @@ fun setSlidesConfiguration(
  * Creates an element that, when used in a `slides` document,
  * shows its content when the user attempts to go to the next slide.
  * Multiple fragments in the same slide are shown in order on distinct user interactions.
+ * @param behavior visibility type of the fragment and how it reacts to user interactions
  * @param content content to show
  * @return the fragment node
  */
-fun fragment(content: InlineMarkdownContent) = SlidesFragment(content.children).wrappedAsValue()
+fun fragment(
+    behavior: SlidesFragment.Behavior = SlidesFragment.Behavior.SHOW,
+    content: InlineMarkdownContent,
+) = SlidesFragment(behavior, content.children).wrappedAsValue()