Add .collapse

iamgio · Sep 5, 2024 · c9d92d4 · c9d92d4
1 parent cca062c
commit c9d92d4
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 0 deletions.
diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/ast/quarkdown/block/Collapse.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/ast/quarkdown/block/Collapse.kt
@@ -0,0 +1,19 @@
+package eu.iamgio.quarkdown.ast.quarkdown.block
+
+import eu.iamgio.quarkdown.ast.InlineContent
+import eu.iamgio.quarkdown.ast.NestableNode
+import eu.iamgio.quarkdown.ast.Node
+import eu.iamgio.quarkdown.visitor.node.NodeVisitor
+
+/**
+ * A collapsible block, whose content can be hidden or shown by interacting with it.
+ * @param title title of the block
+ * @param isOpen whether the block is open at the beginning
+ */
+data class Collapse(
+    val title: InlineContent,
+    val isOpen: Boolean,
+    override val children: List<Node>,
+) : NestableNode {
+    override fun <T> accept(visitor: NodeVisitor<T>): T = visitor.visit(this)
+}
diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/rendering/html/BaseHtmlNodeRenderer.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/rendering/html/BaseHtmlNodeRenderer.kt
@@ -33,6 +33,7 @@ import eu.iamgio.quarkdown.ast.quarkdown.FunctionCallNode
 import eu.iamgio.quarkdown.ast.quarkdown.block.Aligned
 import eu.iamgio.quarkdown.ast.quarkdown.block.Box
 import eu.iamgio.quarkdown.ast.quarkdown.block.Clipped
+import eu.iamgio.quarkdown.ast.quarkdown.block.Collapse
 import eu.iamgio.quarkdown.ast.quarkdown.block.Math
 import eu.iamgio.quarkdown.ast.quarkdown.block.PageBreak
 import eu.iamgio.quarkdown.ast.quarkdown.block.SlidesFragment
@@ -255,6 +256,8 @@ open class BaseHtmlNodeRenderer(context: Context) : TagNodeRenderer<HtmlTagBuild
 
     override fun visit(node: Box): CharSequence = throw UnsupportedRenderException(node)
 
+    override fun visit(node: Collapse): CharSequence = throw UnsupportedRenderException(node)
+
     override fun visit(node: Whitespace): CharSequence = throw UnsupportedRenderException(node)
 
     override fun visit(node: TableOfContentsView): CharSequence = throw UnsupportedRenderException(node)

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
@@ -15,6 +15,7 @@ import eu.iamgio.quarkdown.ast.quarkdown.FunctionCallNode
 import eu.iamgio.quarkdown.ast.quarkdown.block.Aligned
 import eu.iamgio.quarkdown.ast.quarkdown.block.Box
 import eu.iamgio.quarkdown.ast.quarkdown.block.Clipped
+import eu.iamgio.quarkdown.ast.quarkdown.block.Collapse
 import eu.iamgio.quarkdown.ast.quarkdown.block.Math
 import eu.iamgio.quarkdown.ast.quarkdown.block.PageBreak
 import eu.iamgio.quarkdown.ast.quarkdown.block.SlidesFragment
@@ -125,6 +126,16 @@ class QuarkdownHtmlNodeRenderer(context: Context) : BaseHtmlNodeRenderer(context
             }
         }
 
+    override fun visit(node: Collapse) =
+        buildTag("details") {
+            if (node.isOpen) {
+                attribute("open", "")
+            }
+
+            tag("summary") { +node.title }
+            +node.children
+        }
+
     override fun visit(node: Whitespace) =
         buildTag("span") {
             style {

diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/visitor/node/NodeVisitor.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/visitor/node/NodeVisitor.kt
@@ -33,6 +33,7 @@ import eu.iamgio.quarkdown.ast.quarkdown.FunctionCallNode
 import eu.iamgio.quarkdown.ast.quarkdown.block.Aligned
 import eu.iamgio.quarkdown.ast.quarkdown.block.Box
 import eu.iamgio.quarkdown.ast.quarkdown.block.Clipped
+import eu.iamgio.quarkdown.ast.quarkdown.block.Collapse
 import eu.iamgio.quarkdown.ast.quarkdown.block.Math
 import eu.iamgio.quarkdown.ast.quarkdown.block.PageBreak
 import eu.iamgio.quarkdown.ast.quarkdown.block.SlidesFragment
@@ -130,6 +131,8 @@ interface NodeVisitor<T> {
 
     fun visit(node: Box): T
 
+    fun visit(node: Collapse): T
+
     fun visit(node: Whitespace): T
 
     fun visit(node: TableOfContentsView): T

diff --git a/core/src/test/kotlin/eu/iamgio/quarkdown/HtmlNodeRendererTest.kt b/core/src/test/kotlin/eu/iamgio/quarkdown/HtmlNodeRendererTest.kt
@@ -34,6 +34,7 @@ import eu.iamgio.quarkdown.ast.base.inline.Text
 import eu.iamgio.quarkdown.ast.quarkdown.block.Aligned
 import eu.iamgio.quarkdown.ast.quarkdown.block.Box
 import eu.iamgio.quarkdown.ast.quarkdown.block.Clipped
+import eu.iamgio.quarkdown.ast.quarkdown.block.Collapse
 import eu.iamgio.quarkdown.ast.quarkdown.block.Math
 import eu.iamgio.quarkdown.ast.quarkdown.block.PageBreak
 import eu.iamgio.quarkdown.ast.quarkdown.inline.MathSpan
@@ -729,6 +730,29 @@ class HtmlNodeRendererTest {
         )
     }
 
+    @Test
+    fun collapse() {
+        val out = readParts("quarkdown/collapse.html")
+
+        assertEquals(
+            out.next(),
+            Collapse(
+                title = listOf(Emphasis(listOf(Text("Hello")))),
+                isOpen = false,
+                children = listOf(Strong(listOf(Text("world")))),
+            ).render(),
+        )
+
+        assertEquals(
+            out.next(),
+            Collapse(
+                title = listOf(Text("Hello")),
+                isOpen = true,
+                children = listOf(BlockQuote(children = listOf(Paragraph(listOf(Text("world")))))),
+            ).render(),
+        )
+    }
+
     @Test
     fun `text transform`() {
         val out = readParts("quarkdown/texttransform.html")

diff --git a/core/src/test/resources/rendering/quarkdown/collapse.html b/core/src/test/resources/rendering/quarkdown/collapse.html
@@ -0,0 +1,23 @@
+<details>
+    <summary>
+        <em>
+            Hello
+        </em>
+    </summary>
+    <strong>
+        world
+    </strong>
+</details>
+
+---
+
+<details open="">
+    <summary>
+        Hello
+    </summary>
+    <blockquote>
+        <p>
+            world
+        </p>
+    </blockquote>
+</details>
diff --git a/stdlib/src/main/kotlin/eu/iamgio/quarkdown/stdlib/Layout.kt b/stdlib/src/main/kotlin/eu/iamgio/quarkdown/stdlib/Layout.kt
@@ -6,6 +6,7 @@ import eu.iamgio.quarkdown.ast.base.block.Table
 import eu.iamgio.quarkdown.ast.quarkdown.block.Aligned
 import eu.iamgio.quarkdown.ast.quarkdown.block.Box
 import eu.iamgio.quarkdown.ast.quarkdown.block.Clipped
+import eu.iamgio.quarkdown.ast.quarkdown.block.Collapse
 import eu.iamgio.quarkdown.ast.quarkdown.block.Stacked
 import eu.iamgio.quarkdown.ast.quarkdown.inline.Whitespace
 import eu.iamgio.quarkdown.context.Context
@@ -32,6 +33,7 @@ val Layout: Module =
         ::whitespace,
         ::clip,
         ::box,
+        ::collapse,
         ::table,
     )
 
@@ -164,6 +166,18 @@ fun box(
     body: MarkdownContent,
 ) = Box(title?.children, type, padding, backgroundColor, foregroundColor, body.children).wrappedAsValue()
 
+/**
+ * Inserts content in a collapsible block, whose content can be hidden or shown by interacting with it.
+ * @param title title of the block
+ * @param open whether the block is open at the beginning
+ * @return the new [Collapse] node
+ */
+fun collapse(
+    title: InlineMarkdownContent,
+    open: Boolean = false,
+    body: MarkdownContent,
+) = Collapse(title.children, open, body.children).wrappedAsValue()
+
 /**
  * Creates a table out of a collection of columns.
  *